Page tree
Skip to end of metadata
Go to start of metadata

On this page:

Target audience:

CAST AI Administrators

Summary: This section explains how to install the CAST schemas. This equates to the installation of the CAST Management Service, CAST Analysis Service, CAST Dashboard Service and the CAST Measurement Service on the CAST Storage Service or on a commercially available and supported RDBMS (in this case this section also discusses any preparation that may be required for your particular RDBMS).

Whether you are installing the CAST schemas on a CAST Storage Service/RDBMS located on the CAST Administration workstation or on a dedicated machine (see Deployment - sizing and security for more information), the installation process needs to be carried out on the CAST Administration workstation using the executable CAST Server Manager (servman.exe).

Installation preparation: requirements and configuration

CAST assumes that you have already installed either the CAST Storage Service or your chosen RDBMS on either the CAST Administration workstation, or on a dedicated machine that can be accessed by the CAST Administration workstation. This guide does not provide instructions on how to install a commercially available RDBMS, but does provide information about how the RDBMS can be configured for use with CAST. Please see Appendix - RDBMS requirements and configuration for more information about installation requirements and RDBMS configuration. It is imperative that this section is read thoroughly before you embark on the Storage item installation process.

Please note that the CAST Storage Service requires no configuration prior to installing the CAST databases. It is pre-configured ready for use.

CAST database installation locations

Before installing any of the CAST schemas, you need to decide where you want to install them:

  • On one single CAST Storage Service or RDBMS
  • On multiple CAST Storage Services/RDBMS (one for each database)

There are no limitations pertaining to the installation of all the CAST databases on the same CAST Storage Service/RDBMS, nor are there any limitations associated with having two or more identical CAST database types on the same CAST Storage Service/RDBMS.

In some cases, for performance, network, usage or administration reasons, you may, however, want to distribute CAST sites across multiple CAST Storage Services/RDBMS, unless you have already sized a dedicated Server powerful enough to handle all CAST databases. In this scenario and when you are specifically using multiple Microsoft SQL Servers to host your CAST databases, you must ensure that all CAST databases use the same collation across all host servers - see Appendix - RDBMS requirements and configuration for more information.

This guide explains how to install all databases on one single CAST Storage Service/RDBMS.

CAST schemas and Applications

CAST recommends that each Application you need to onboard and analyze with CAST is configured to have sole use of a "triplet" of CAST schemas as follows:

Application 1 uses:

  • Management Service A
  • Analysis Service A
  • Dashboard Service A

If you need to analyze any additional Applications, CAST recommends that for each additional Application you install a new additional "triplet" of CAST schemas:

Application 2 uses:

  • Management Service B
  • Analysis Service B
  • Dashboard Service B

With regard to Measurement Services that are required for the CAST Application Analytics Dashboard, you can choose to:

  • Consolidate all Applications (regardless of whether their snapshot data is stored in multiple CAST Dashboard Services) in one Measurement Service - in this way, snapshot data from all Applications will be visible in one CAST Application Analytics Dashboard
  • Consolidate each Application in a separate Measurement Service and CAST Application Analytics Dashboard - this ensures that Application snapshot data is segregated.

Example setup

One example setup (when using the CAST Storage Service) would be to:

  • install all four CAST schemas in one go (see below) and onboard the first Application
  • install a "triplet" of CAST schemas in one go (see below) for each additional Application you want to onboard. Snapshot data from these Applications can be consolidated:
    • in the Measurement Service installed initially for the first Application (snapshot data for all Applications is consulted through one single CAST Application Analytics Dashboard)
    • or can be consolidated in additional standalone Measurement Services (snapshot data is segregated and is consulted for each Application through a dedicated CAST Application Analytics Dashboard for that Application)

CAST AIP extensions

CAST provides support for a variety of technologies through what are known as "extensions". An extension is a generic term for any kind of distinct addition to CAST AIP which can be downloaded, installed and upgraded separately. Extensions provided by CAST can provide support for the analysis of technologies such as PHP or the extraction of code from a Git repository, for example.

Extensions require installation and this can be done in two ways:

  1. During the installation of your CAST schemas
  2. After your CAST schemas have been installed

If you would like to install the extension during the installation of your CAST schemas, you must ensure that you have downloaded the required extension already. Please refer to Download your CAST AIP Extensions for more information about this.

Pre-installation check list

Before beginning the CAST database 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 the machine to be used to host the CAST Storage item (either the CAST Administration workstation or a dedicated machine) meets all hardware and operating system requirements (see Appendix - CAST Administration workstation installation and hardware requirements)

(tick)

If using a commercially available RDBMS (instead of the CAST Storage Service):

  • ensure that it is installed correctly. Pay particular attention to the way the RDBMS will manage case sensitivity compatibility through all components (see Appendix - RDBMS requirements and configuration).
  • ensure that your RDBMS login has sufficient privileges to create databases/schemas (see Appendix - RDBMS requirements and configuration).
  • whatever your network architecture, if your target RDBMS is a Microsoft SQL Server, you need to create a 64-bit ODBC entry on the CAST Administration workstation for this particular server type.
    if your target RDBMS is located on a dedicated machine separate from the machine used to host the CAST Administration workstation and is an Oracle Server, you may need to install a compatible 64-bit client connection layer on the CAST Administration workstation. Note that if you do not have sufficient rights to install the full Oracle client, installing the "Application Development" and "Configuration and Migration Tools" components will be sufficient.

(tick)

If the CAST Storage Service or RDBMS is installed on a remote dedicated machine:

  • Make sure that the CAST Administration workstation can access the remote dedicated machine over the network - this may entail creating appropriate firewall rules to allow the connection.
  • In the case of a commercially available RDBMS, some systems may require the installation of a supported RDBMS client connection layer (see the Release Notes).

(tick)

Decide whether you want to install the CAST databases in existing database/schemas or in new database/schemas - this guide assumes that you will install them in new database/schemas.

Note that you CANNOT use the installation options that install multiple databases in one go (see below) to install to existing database/schemas.

(tick)

If you want to install an extension with your new CAST schemas/databases, please refer to http://doc.castsoftware.com/help/topic/DOCEXT/Extension_download_and_installation.html for more information.

CAST Server Manager

To start the CAST database installation process, launch the CAST Server Manager executable (servman.exe) on the CAST Administration workstation.

Connection

When you first launch CAST Server Manager, depending on your environment and previous installation choices, one of two things will happen:

CAST Storage Service installed on CAST Administration workstation with the current version of the Windows installer

A connection profile to the CAST Storage Service is automatically created during the CAST Storage Service installation process (see Install CAST AIP components) and can be selected in the Open Server Connection dialog box (see below).

RDBMS installed on CAST Administration workstation

No connection profile is automatically created - you need to create your own connection profile (see below).

CAST Storage Service or RDBMS installed on remote dedicated machine

CAST Storage Service installed with previous version of CAST AIP

Using the auto created profile for CAST Storage Service

If a connection profile to the CAST Storage Service is automatically created, when you launch CAST Server Manager, the connection profile is then offered to you in the Open Server Connection Profile dialog box so that you can immediately connect to install the CAST databases:

  • Select the profile called "CASTStorageService2"
  • Click the Open button.
  • Once the connection is established, you can then proceed with the installation of the CAST databases.

Manually creating a connection profile for CAST Storage Service and other RDBMS

If the CAST Storage Service is installed on a remote machine, or you are using a commercially available and supported RDBMS to host the Storage item (whether on the CAST Administration workstation or on a dedicated machine), you will need to manually create a connection profile for the target CAST Storage Service/RDBMS which will host the CAST databases.

When launching CAST Server Manager, you will be prompted that no connection profiles exist - click Yes to continue:

  • In the Add Server Connection Profile dialog box, insert the required connection parameters (ensuring that you chose the correct "Server type") and click Test to test the profile (see the CAST Server Manager on-line help for more information about the required parameters).
  • Click OK to save it.

  • Use this profile to establish a connection (use the Open button in the Open Server Connection dialog box) to the CAST Storage Service/RDBMS:

  • When a connection is established, you can then proceed with the installation of the CAST databases.
  • For Microsoft SQL Server (whatever your network architecture):
    • you may first need to create a 64-bit ODBC entry on the CAST Administration workstation for this particular server type.
    • when creating a 64-bit ODBC entry, please do not create an alias for your Microsoft SQL Server and then use that alias in the CAST Server Manager Connection Profile (the installation will fail)
  • For Oracle Server(if the RDBMS is located on a dedicated machine separate from the machine used to host the CAST Administration workstation):
    • You may need to install a compatible 64-bit client connection layer on the CAST Administration workstation (see the Release Notes for a list of compatible client connection layers).
  • Now select Schema/Database Installation from the Schema/Database Installation menu:
Microsoft SQL ServerCAST Storage Service/Oracle Server
  • The CAST Base Installation dialog box will then be displayed (this dialog box enables you to choose what type of installation operation you want to carry out with CAST Server Manager). The options available in this dialog box are explained below.

Available installation options

Left column optionsRight column optionsWhat is installed?When should I choose this option?
Initial platform base(s) installationApplication Analytics platform installation

All four CAST database are installed automatically with the following suffixes:

  • Management Service (_MNGT)
  • Analysis Service (_LOCAL)
  • Dashboard Service (_CENTRAL)
  • Measurement Service (_MEASURE)

Choose this option if you are installing CAST AIP from scratch and require access to all functionality (and have appropriate licensing to do so).

Note this option is ONLY available if you are using the CAST Storage Service 2 as your chosen storage host. This is because the Measurement Service can only be installed on a CAST Storage Service 2.
Additional Analysis platform

Three CAST databases are installed automatically with the following suffixes:

  • Management Service (_MNGT)
  • Analysis Service (_LOCAL)
  • Dashboard Service (_CENTRAL)

Choose this option if:

  • you are installing a additional Management, Analysis and Dashboard Services to onboard additional Applications for analysis.
  • you are installing CAST on Oracle Server or Microsoft SQL Server
  • you are not licensed or do not intend to use the CAST Application Analytics Dashboard
CAST-MS onlyOnly the Management Service database is installed. You are free to choose the name of the database.Choose this option only if you require an additional Management Service, i.e. for situations where you are distributing the CAST databases across multiple host CAST Storage Services/RDBMS.
  • Additional Knowledge Base
  • Additional Central Base
  • Additional Measurement Base
  • General
  • Produce Information
  • User Interaction
One additional CAST database is installed: the type depends on the option you have selected.

Choose these options only if you require additional Analysis, Dashboard or Measurement Services, i.e. for situations where you are distributing the CAST databases across multiple host CAST Storage Services/RDBMS, or where you are migrating from a previous version that did not include the specific database.

CAST recommends that you choose the General option for all additional CAST database installations.

Note that the Additional Measurement Base option is ONLY available if you are using the CAST Storage Service 2 as your chosen storage host. This is because the Measurement Service can only be installed on a CAST Storage Service 2.

CAST recommends selecting the Application Analytics platform or Additional Analysis Platform installation options unless you know what you want to achieve. These options are explained below.

Combined installation

If you are starting from scratch, CAST recommends that you use the Application Analytics platform or Additional Analysis Platform installation options - this will install all required CAST databases in one go - i.e. a Combined Installation.

Note that you cannot use the Application Analytics platform or Additional Analysis Platform installation options with existing database/schemas - as such, new database/schemas will ALWAYS be created if you use these options.
  • In CAST Server Manager, select Schema/Database Installation from the Schema/Database Installation menu:

Microsoft SQL Server

CAST Storage Service/Oracle Server

  • The CAST Base Installation dialog box will then be displayed. You should select Initial platform base(s) installation in the left hand section and either the Application Analytics platform or the Additional Analysis Platform installation option (depending on your requirement and the type of RDBMS/CSS you are using to host the databases) in the right hand section, then click Next.

  • The Extension Selection dialog box will then be displayed. This dialog box allows you to select and install CAST extensions at the same time as you install your CAST schemas. Select the extensions you want to install (note that selecting one extension may automatically select other extensions for installation if the extension you selected has dependent extensions). If you do not want to install an extension at this time, ensure that Do not install is displayed for all extensions in the Version column. Click Next to continue.

  • The Schema/Database Creation dialog box will then be displayed. This dialog box will prompt you to enter a prefix that will be applied to the name of all new database/schemas that will be created during the installation process. The resulting databases/schemas will take the form:
    • <prefix>_MNGT > Management Service
    • <prefix>_LOCAL > Analysis Service
    • <prefix>_CENTRAL > Dashboard Service
    • <prefix>_MEASURE > Measurement Service (only for the Application Analytics platform installation option)

Password
If you are performing the installation on an Oracle Server, then you will also need to input a password. This password is associated with the user that owns the schemas you are about to create (the user and the schema have the same name). You will be prompted for it for each schema that is installed. The User Password option does not exist on other server types.

Naming convention requirements
For all server types please note the following CAST requirements:

  • the name must be in upper case
  • the following characters are authorized: 0-9, A-Z and _ (underscore)
  • RDBMS specific naming rules also apply - please see the documentation for your specific RDBMS for more information.
  • Click Next to continue. The next step involves defining installation configuration settings for the databases/schemas that will be created. Depending on the type of server you are connected to, the process will differ. This process is described in more detail in Appendix - CAST database - creation and configuration options.
  • A dialog box displaying a summary of the proposed installation will then be displayed. Click Proceed to start the component installation:

  • A dialog box will inform you of installation progress:

  • When all operations have been successfully completed, CAST Server Manager will display the newly installed databases/schemas together as shown below (the Measurement Service will not be visible if you selected the Additional Analysis platform installation option):

During the installation process, CAST Server Manager will automatically create a connection profile to the CAST Management Studio database/schema (<prefix>_MNGT). This connection profile is stored in a proprietary XML file on the hard drive of the CAST Administration workstation. When you launch the CAST Management Studio, this connection profile will automatically be displayed for use (you will need to validate it first).

Standalone installation

CAST enables you to install any of the CAST databases/schemas in standalone mode - i.e. on their own without any other databases/schemas. The most common situations in which this is required is as follows:

  • Migration from a previous version of CAST AIP - for example when upgrading to the current version from CAST AIP 7.0.x and you would like to use the CAST Application Analytics Dashboard (in this situation, you need a Measurement Service)
  • Where you are distributing the CAST databases across multiple host CAST Storage Services/RDBMS -  you can install each CAST database on its own.

To do so:

  • In CAST Server Manager, select Schema/Database Installation from the Schema/Database Installation menu:

Microsoft SQL Server

CAST Storage Service/Oracle Server

  • The CAST Base Installation dialog box will then be displayed.
  • Follow the instructions below depending on the CAST database you want to install.

Standalone Management Service

Standalone Analysis, Dashboard or Measurement Service

To install a standalone Management Service:

  • Select Initial Platform Base(s) installation > CAST-MS only:

To install a standalone Analysis, Dashboard or Measurement Service:

  • Select Additional <service type> > General:

  • The Extension Selection dialog box will then be displayed. This dialog box allows you to select and install CAST extensions at the same time as you install your CAST schema. Select the extensions you want to install (note that selecting one extension may automatically select other extensions for installation if the extension you selected has dependent extensions). If you do not want to install an extension at this time, ensure that Do not install is displayed for all extensions in the Version column. An extension MUST be installed in a Management, Analysis and Dashboard Service for it to function correctly. In other words, if you are installing a standalone Analysis Service and have selected an extension for installation, then you also need to install the same version of that extension to any Management or Dashboard Services you will be using with the current standalone Analysis Service - for this reason, CAST highly recommends that you use the Combined Installation option instead, as described above. 

  • Click Next and enter a name for the database (the same Password for Oracle host servers and Naming convention requirements as discussed in the Combined Installation section (above) are valid).

  • Click Next to continue. The next step involves defining installation configuration settings for the database/schema that will be created. Depending on the type of server you are connected to, the process will differ. This process is described in more detail in Appendix - CAST database - creation and configuration options.
  • A dialog box displaying a summary of the proposed installation will then be displayed. Click Proceed to start the component installation.
  • When all operations have been successfully completed, CAST Server Manager will display the newly installed database/schema and it can be used immediately.

If you choose to install a standalone Management Service, CAST Server Manager will automatically create a connection profile to it. This connection profile is stored in a proprietary XML file on the hard drive of the CAST Administration workstation. When you launch the CAST Management Studio, this connection profile will automatically be displayed for use (you will need to validate it first).

  • No labels