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

On this page:

Target audience:

CAST AI Administrator

Summary: this section explains how to initialize the CAST Management Studio  - i.e. configure a CAST license key and define the source code Delivery and Deployment folders.

Introduction

Once the CAST schemas have been successfully installed (see previous step: Install CAST schemas) you now need to initialize some settings that are required by the CAST Management Studio. You can do this in two ways:

  • Via the CAST Management Studio GUI - this method is best used in small deployments where only a handful of Applications (and therefore a small number of CAST schema triplets) require initialization. This option requires that you open the CAST Management Studio, connect to EACH Management Service and then configure the required settings for each Management Service schema.
  • Via the CAST Management Studio CLI - this method is best used in large scale deployments where many dozens of Applications require initialization. This method allows the settings to be configured via a batch script file and therefore does not require that the CAST Management Studio is opened for EACH Management Service schema.

Via the CAST Management Studio GUI

When using this method, you must repeat the instructions for each Management Service schema that you have installed. The CAST Management Studio should be run from the CAST Administration workstation installed in Step 1: Install CAST AIP components.

Launch the CAST Management Studio

The CAST Management Studio can be launched as follows:

  • Either by selecting the CAST Management Studio shortcut location in the Start menu (created when running the CAST AIP Windows installer)
  • Or by navigating to the CAST installation folder and double clicking the CAST-MS.exe application
  • The Database Connection Manager will then be displayed:

  • During a combined installation process (simultaneous installation of all CAST databases - Analysis/Dashboard/Management/Measurement Services, see Install CAST schemas) CAST Server Manager will automatically create a connection profile to the Management Service (<prefix>_MNGT) you have installed. If you did not install the CAST databases using a combined install option, then no connection profile will be available and you will need to create one by clicking the button and defining the details of the Management Service (<prefix>_MNGT).
  • Select the connection profile in the list, and then click Connect.
  • The Startup Wizard will then be displayed.
Please note that only one single instance of the CAST Management Studio should be used with one single Management Service. CAST does not recommend using multiple instances of the CAST Management Studio (on different workstations for example) to interact with the same Management Service. Data corruption is highly likely and cannot be repaired.

Using the Startup wizard to define the license key and delivery/deployment folders

The Startup wizard is only launched the very first time you launch the CAST Management Studio. In subsequent launches, the wizard will not be displayed.

The Startup wizard guides you through the configuration of various mandatory settings. These settings are vital to the CAST Management Studio and without them you cannot use CAST AIP:

  • Click the Next button to start the wizard.
  • This page prompts you to enter your CAST license key:

  • Enter the license key provided to you by CAST, the license key is now registered and valid for ALL end-user applications. Note that future Licence Key registration and activation can either be handled using the Help > License Key menu in the CAST Management Studio or by running the ConfigurePlatformPreferences CLI option as discussed below.
  • Click Next to move to the next page in the wizard:

  • In order to function correctly, the CAST Management Studio requires two folders that are used to store Source Code:
Source Code Delivery Folder

A central location for storing successive and compressed versions of an application's source code as packaged by the Delivery Manager(s).

You must define the EXACT SAME Delivery Folder location as defined when you installed the CAST AIC Portal (see Installing and configuring the CAST AIC Portal). You can find out more information about the configuration of the Delivery folders in Where should the Delivery folder be located.
Source Code Deployment FolderA storage location that is only accessed by the CAST Management Studio, as such CAST recommends defining a "local" folder on the CAST Administration workstation (i.e. the machine on which the CAST Management Studio is installed).
Both folders must be capable of receiving large amounts of data (i.e. source code packaged by the CAST Delivery Manager Tool and any associated configuration files).
  • There are two options available to you:
Default FoldersThis option will create a folder tree in the root of the selected drive as follows:
  • DRIVE:\CASTMS\Delivery
  • DRIVE:\CASTMS\Deploy

In addition, the Log Root Directory, Large intermediate storage area and Large temporary storage area options (see Window > Preferences > CAST General in the CAST Management Studio) will also be configured to the DRIVE:\CASTMS location.

If you select this option then you must ensure that the CAST AIC Portal is also defined to use this auto-defined Delivery folder (i.e.: DRIVE:\CASTMS\Delivery), which may not be appropriate.
Custom Folders

This option allows you to choose the location for the Source Code Delivery Folder and Source Code Deployment Folder yourself. This is useful if the default location of DRIVE:\CASTMS is not appropriate - i.e. the folder you want to define is not on the local machine.

The location must already exist on the drive before you input it. You can manually enter the path to the folder by hand or use the Browse buttons to select the location.

Please note that you can use the following syntax:

  • D:\CAST\DELIVERY (folder local to the host machine) - Please use this syntax when the CAST AIC Portal and the CAST Management Studio are located on the SAME machine. In this situation, always enter an absolute path to the local drive containing the Delivery folder (for example D:\ CAST\DELIVERY). Please DO NOT use a mapped drive path (created using the Windows GUI or the subst Windows command) that points to a folder on the local machine or to a remote network share - doing so can cause an error that will prevent the CAST AIC Portal/CAST Management Studio from functioning.
  • \\HOST\CAST\DELIVERY (folder on a remote network share) - note that forward slashes will also function. Please use this syntax only when the CAST AIC Portal and the CAST Management Studio are located on different machines. Note that forward slashes will also function.

Note:

  • Any user that wishes to interact with the Delivery folder from the CAST Management Studio (for example, when Accepting a delivery, using the Set as current version option or when running the CAST Delivery Manager Tool from the CAST Management Studio) will require read/write access permissions on the Delivery folder
  • You cannot choose the same location for each folder -
  • You must ensure that:
    • a different location is used for each folder (i.e. the Delivery folder should not be a sub-folder of the Deployment folder or vice-versa)
    • each folder is completely separate from the location used to store your source code - i.e. errors will arise if you configure the Delivery and Deployment folders to be located in sub-folders or a source code storage location
  • If you select this option, the Log Root Directory, Large intermediate storage area and Large temporary storage area options will use default locations (see Window > Preferences > CAST General in the CAST Management Studio).
  • Make your choice and then click Finish to complete the Startup Wizard.
  • The CAST Management Studio will then be displayed.

Via the CAST Management Studio CLI

When using this method, you must repeat the instructions for each Management Service schema that you have installed - however, you can combine the instructions for each Management Service schema in one batch file and then run that batch file to configure all settings on one go.

To use this method, CAST recommends creating an empty batch file and placing the required commands in the batch file - the batch file can then be executed simply by double clicking it. To execute the action via the command line, you must specify the CAST-MS-CLI.exe executable (rather than the CAST-MS.exe executable). The syntax required is as follows:

CAST-MS-CLI.exe ConfigurePlatformPreferences -connectionProfile "<profile_name>" -licenseKey "<license_key>" -sourceDeliveryFolder "<path_to_delivery_folder>" -sourceDeploymentFolder "<path_to_deployment_folder"
OptionDescription

-connectionProfile

Specifies the name of connection profile to use to connect to the chosen CAST Management Service schema. You can obtain this information from the Connection Profile dialog box in the CAST Management Studio - note that Connection Profiles can include white space, in which case, please ensure that you surround the name with quote marks:

During a combined installation process (simultaneous installation of all CAST databases - Analysis/Dashboard/Management/Measurement Services, see Install CAST schemas) CAST Server Manager will automatically create a connection profile or profiles to the Management Service(s) (<prefix>_MNGT) you have installed. If you did not install the CAST schemas using a combined install option, then no connection profile will be available and you will need to create one by clicking the  button and defining the details of EACH Management Service schema (<prefix>_MNGT) that requires initialization.

-licenseKey

Enter the license key provided to you by CAST.

-sourceDeliveryFolder

Enter the location for the Source Code Delivery Folder and Source Code Deployment Folder. Please see the section above in the table entitled "Custom folders" for more information about the path syntax that can be used.

-sourceDeploymentFolder

Output codes

The CLI will return two output codes:

  • 0 = No error (successful execution)
  • 2 = Error exists (for example the license key may be in the wrong format)

Logging

By default (if no logging option is used in the CLI), the CLI will use the following location to store the log file relating to this process:

%TEMP%\CAST\CAST\<version_number>\CAST-MS<number>.log.txt

You can override the default log location using the following syntax enclosing the string in double quotes if it contains white space. The specified folder does not need to exist already:

-logRootPath <string>

Example

The following example updates one Management Service schema with a license key, a Delivery folder path, a Deployment folder path and includes a log file location:

CAST-MS-CLI.exe ConfigurePlatformPreferences -connectionProfile "v800_8348_mngt on CastStorageService _ NEFYN:2280" -licenseKey "xxxxx" -sourceDeliveryFolder "C:\CAST\Delivery" -sourceDeploymentFolder "C:\CAST\Deploy" -logRootPath "C:\CAST\Log"

Notes

  • Once the settings have been successfully initialized using the command line interface, opening the CAST Management Studio and connecting to the Management Service in question for the first time will NOT cause the Startup wizard to be displayed.
  • It is not possible to use the CLI interface to update the Delivery and Deployment folders once they have been set either via the Startup wizard or via the CLI. If you attempt to do so, the CLI will display an error. Please use the CAST Management Studio GUI interface to make this change if it is required (menu option: Window > Preferences > Platform Settings)
  • It is possible to use the CLI interface to update the License Key once it has already been set either via the Startup wizard or via the CLI. The syntax is as follows:
CAST-MS-CLI.exe ConfigurePlatformPreferences -connectionProfile "<profile>" -licenseKey "<xxxxx>"

Importing the Assessment Model for a CAST AIP Extension (optional)

If you have installed a CAST AIP Extension while installing the CAST AIP schemas, you now need to import the Assessment Model to ensure that any Quality Rules delivered with your CAST AIP Extension are activated when you run an analysis/generate a snapshot:

  • Launch the CAST Management Studio and open the Dashboard Service editor for your newly installed CAST Dashboard Service schema:
  • In the Assessment Model tab, click the Import Assessment Model option as highlighted below:


  • This action will:
    • import the Assessment Model (containing the updates added by the installation of the extension) into the Assessment Models view
    • assign the imported Assessment Model to the Dashboard Service so that it is used when a new snapshot is generated
  • No labels