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

Summary: this page describes how to configure Console to use custom extensions that are not available in CAST Extend (or the equivalent offline CAST Extend Offline).

This information is valid only for ≥ 1.14.x releases of Console.

Introduction

Console uses CAST Extend (or the equivalent offline CAST Extend local server) to obtain information about extensions that are required for analysis on each Node (see Application - Extensions for more information), however, some extensions (specific custom extensions) that may be required are not available in CAST Extend. Due to this requirement, Console will scan a folder location in which these custom extensions can be stored and used when required: information on any that are found is merged with the extension information received from CAST Extend and displayed in the Available Extensions panel (see Application - Extensions for more information).

Note that:

  • In Console ≥ 2.x, a common folder is defined out of the box and requires no additional configuration. This location must be used and cannot be changed. It is located the shared folder location: \\SERVER\aip-node-data\common-data\extensions
  • In Console 1.x (≥ 1.14.x) you must designate one shared drive or network location in which to store the custom extensions and then configure this location on all Nodes managed with Console.
  • In all releases of Console, extensions must be stored in the designated location in *.nupkg format.

Using a custom extension in an analysis

To use a custom extension in an analysis, the extension will need to be manually included using the Available Extensions panel (see Application - Extensions for more information) in Console . This means that you will need to perform an advanced onboarding action where each step is actioned one by one, allowing you to install the extension after the source code is delivered and before the analysis starts. 

Configuration for Console 1.x

Step 1 - Edit the configuration file

A configuration file contains a section dedicated to CAST Extend. This file is available on EACH Node, therefore if you have more than one Node, you will need to make this change on all Nodes with which you want to use custom extensions. To do so, first locate this file:

%PROGRAMDATA%\CAST\AipConsole\AipNode\aip-node-app.properties

Edit the file with a text editor and locate the following section:

# ==============
# The following value are filled automatically by installer when installing cms-api
# --------------
spring.liquibase.change-log=classpath:db/changelog/db.changelog-master.xml
spring.liquibase.parameters.baseToken=3vZIP9xYgZ9ZFpS0wDiA
# For upgrade from previous version of AIP Node
spring.liquibase.parameters.extend.server=${cmsapi.extend.server.url}
spring.liquibase.parameters.extend.username=${cmsapi.extend.username}
spring.liquibase.parameters.extend.password=${cmsapi.extend.password}
extend.folder=

Define the location of the storage location using the extend.folder option (see required path syntax below):

# ==============
# The following value are filled automatically by installer when installing cms-api
# --------------
spring.liquibase.change-log=classpath:db/changelog/db.changelog-master.xml
spring.liquibase.parameters.baseToken=3vZIP9xYgZ9ZFpS0wDiA
# For upgrade from previous version of AIP Node
spring.liquibase.parameters.extend.server=${cmsapi.extend.server.url}
spring.liquibase.parameters.extend.username=${cmsapi.extend.username}
spring.liquibase.parameters.extend.password=${cmsapi.extend.password}
extend.folder=N:\\custom_extensions

Required path syntax

The path entered into the .properties file for the extend.folder option must use the following syntax:

Path typeRequired syntaxExamples
UNC network pathBack slashes escaped with a back slash.\\\\server\\some\\path
Local pathForward slashes, not escaped, or back slashes escaped with a back slash.

D:/CAST/some/path

D:\\CAST\\some\\path

Mapped drive

Forward slashes, not escaped, or back slashes escaped with a back slash.

S:/some/path

S:\\some\\path

Step 2 - Apply configuration changes

Restart the Node and Console to ensure all changes are taken into account.

  • No labels