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

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

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

Introduction

AIP Console uses CAST Extend (or the equivalent offline CAST Extend Offline) to obtain information about extensions that are required for analysis on each AIP 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, an option exists which allows you to configure, per AIP Node, a folder location in which these custom extensions are stored. This folder location is scanned for extensions and 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).

Tips:

  • Extensions must be stored in the designated location in *.nupkg format.
  • You can designate one shared drive or network location in which to store the custom extensions and then configure this location on all AIP Nodes managed with the AIP Console.

Configuration steps are described below.

Step 1 - Edit the configuration file

A configuration file (aip-node-app.properties) contains a section dedicated to CAST Extend. This file is available on EACH AIP Node, therefore if you have more than one AIP Node, you will need to make this change on all AIP Nodes with which you want to use custom extensions.

To do so, first locate this file:

<installation_folder>\AipNode\data\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 AIP Node and AIP Console to ensure all changes are taken into account:

  • If the AIP Node / AIP Console are installed as a Windows Service, restart the services
  • If the AIP Node / AIP Console are running only using the batch files, close the CMD windows to stop the processes, then restart then using the following files:
AIP Node: <AIP_console_installation>\AipNode\tools\runAipNode.bat
AIP Console: <AIP_console_installation>\AipConsole\tools\runAIPConsole.bat
  • No labels