Configuration options - config files on Documentation - V2

Blacklisting extensions

Mon, 01 Jan 0001 00:00:00 +0000

Introduction

Sometimes you may need to blacklist a specific extension from being auto-installed, for example:

the extension may not be compatible with the release of AIP Core you are using on your Node
the extension may be known to cause specific issues for your environment
the extension does not match your extension strategy (see Administration Center - Extensions Strategy / Administration Center - Settings - Extensions Strategy) - i.e. it is an alpha or beta and these are forbidden - and is requested automatically by Console
the extension is not present in your Extend local server and is requested automatically by Console

Things to be aware of before blacklisting an extension:

Changing extension storage location on Node

Mon, 01 Jan 0001 00:00:00 +0000

Introduction

By default, extensions that are required for analysis purposes are downloaded by CAST Console and stored in the following location on each Node connected to Console:

%PROGRAMDATA%/CAST/CAST/Extensions

This folder can become quite large after a long period of time where successive releases of CAST Extensions are downloaded and stored and therefore you may need to change where the extensions are stored.

Changing the storage location

Info

The extension storage location is set on a per Node basis, therefore if you want to change the location to a shared network folder, you must make the change described below on all Nodes.

Configuring AIP Console and AIP Nodes to use a proxy

Mon, 01 Jan 0001 00:00:00 +0000

Info

Summary: this page describes how to configure Console and Nodes to use a proxy server if your organization requires this.

Note

This information is valid only for Console**≤ 1.14.x**. If you are using ≥ 1.15.x, proxy settings are provided in Complete start-up wizard - v. 1.x, Complete start-up wizard - v. 2.x and the Administration Center.

Introduction

If your organization requires internet connections to pass through a proxy server, then you will need to configure Console and Node to use this proxy server. At the current time, it is not possible to configure the Console and Node Windows Services to use a proxy, instead you must launch Console and your Nodes with the .bat/.sh files provided during the installation process.

Configuring AIP Console session timeout

Mon, 01 Jan 0001 00:00:00 +0000

Note

This documentation is valid only for Console 1.x.

Introduction

The Console front-end user interface has a built in session timeout feature. By default, after 1200 seconds (20 minutes), a popup will be displayed enabling you to log back in. If you enter credentials in popup and click Log in, you will return to the location you were working on when the session expired. If you click the Log in with another account button, you will be redirected to the main login page and on login you will not return to the previous location:

Configuring Console to use custom extensions

Mon, 01 Jan 0001 00:00:00 +0000

Info

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 local server).

Note

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).

Configuring connection settings to PostgreSQL

Mon, 01 Jan 0001 00:00:00 +0000

Introduction

Out of the box, CAST Console will open and maintain connections to the configured PostgreSQL instances from the various services as follows:

	Node service(s) for result storage	Node service(s) to aip_node schema	Registry service to aip_config schema
Console ≥ 2.x	✅	✅	✅
Console 1.x	✅	❌	❌

The services are set to open the following number of connections by default:

	minimum idle	maximum pool size
Console ≥ 2.6.2	5	10
Console 2.0 - 2.6.1	-	-
Console 1.x	10	10

Where the following explains the two values:

Configuring custom AIP Console access URL

Mon, 01 Jan 0001 00:00:00 +0000

Note

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

Info

Summary: this page describes how to configure a specific access URL for Console.

Introduction

By default, Console will be accessible with the following URL:

http(s)://<host>:<port>/ui/index.html

However, you can modify this to add a specific context in to the URL, for example:

http(s)://<host>:<port>/<context>/ui/index.html

Configuration steps are described below.

Step 1 - Edit the configuration file

A configuration file (aipConsole.properties) contains a section specifically to make this change. First locate this file:

Configuring email notifications

Mon, 01 Jan 0001 00:00:00 +0000

Info

Summary: this page describes how to configure Console to send out email notifications for “job” (snapshot/analysis) related statuses.

Introduction

Users can be notified via email with regard to the following “job” related statuses:

job successfully completed
job failed due to an error
user manually stopped a job
application creation successful
new version created
etc.

Email notifications are sent to all users with permission to manage an Application in Console.

Configuring framework detector timeout

Mon, 01 Jan 0001 00:00:00 +0000

Info

This documentation is valid only for Console ≥ 2.6.3.

Introduction

The “framework detector” is a tool used by Console and run on each Node to determine the contents of a source code folder during the fast scan/version delivery process. The tool is executed in the Content Discovery step:

By default this tool is configured to run for 90 minutes and when this is reached, Console will stop the process, thereby causing the fast scan or code delivery step to fail:

Configuring Indicators

Mon, 01 Jan 0001 00:00:00 +0000

Info

Summary: this page describes how to configure the Indicators feature.

Introduction

The Indicator feature provides a set of indicators for a given analysis or snapshot - see Application - Overview for more detailed information. These indicators are designed to provide basic information quickly so that the analysis/snapshot can be validated. The following indicators can currently be configured to be displayed on completion of an analysis or snapshot:

Artifacts in transactions
Complete Transactions with only end point
Data entities used by transactions
Incomplete transactions
Part of functional enhancement
Programs/Classes in transactions
TF/DF weight ratio
Delivery related indicators
etc.

This feature is enabled “out-of-the-box” in ≥ 1.20.x releases of Console. If you need to disable it, this requires a modification to the Node configuration file. See instructions below.

Configuring Nodes with multiple IP addresses to register with a hostname

Mon, 01 Jan 0001 00:00:00 +0000

Info

Summary: this page describes how to configure Nodes with multiple active network interfaces and therefore multiple IP addresses to register with the Console service registry using a hostname instead of an IP address.

Note

This information is valid only for Console**≥ 2.x** when using Enterprise mode.

Introduction

Out of the box, Nodes are configured to register themselves with the Console service registry using an IP address: this ensures that the Node can be reached at all times. However, sometimes a Node may have more than one active network interface and therefore more than one assigned IP address at any one time. In this situation, the Node will register itself with the Console gateway using one of the active IP addresses at random. This situation will usually work fine, however, if the Node has registered itself with one of its network interfaces/IP addresses that subsequently changes or is disabled, then communication between Console and the Node will fail and the Node will be marked as unavailable in the Administration Center - Nodes panel. To resolve this situation, there are two options as detailed below.

Configuring persistence database backup

Mon, 01 Jan 0001 00:00:00 +0000

Info

Summary: information about backing up the persistence databases used by Console (front-end) and all Nodes.

Note

This documentation is valid only for Console 1.x.

Introduction

Console (front-end) and all Nodes use a persistence database (h2) to store information about global and application level settings. These databases are located by default here:

%PROGRAMDATA%\AipConsole\AipConsole\db > Console front-end
%PROGRAMDATA%\AipConsole\AipNode\db > Node

Automatic backup

By default in ≥ 1.24, these databases are backed up automatically to the following locations at 1am on a nightly basis. For Nodes, the location is determined by storage folder settings - see Configure AIP Node storage folder locations - optional - v. 1.x for more information.

Configuring RAM for AIP Console front-end and AIP Nodes

Mon, 01 Jan 0001 00:00:00 +0000

Info

Summary: This page provides information about changing the RAM allocation for Console or Node services when deployed via Java JAR/Windows installers whether in 1.x or ≥ 2.x (enterprise and standalone mode). When using ≥ 2.x enterprise mode and you have deployed via Docker, RAM allocated to containers is managed by Docker.

Introduction

RAM requirements for host servers are listed in **CAST AIP for Dashboards - Hardware requirements**or in Hardware requirements for CAST Imaging, however, “out of the box”, when running Console/Node in a non-Docker deployment scenario (i.e. using the Java JAR/Windows installers), the Windows Services and batch scripts made available to run the services (which are all Java services) are configured to run with conservative RAM memory allocations as shown in the table below:

Configuring the automatic UTF-8 conversion feature

Mon, 01 Jan 0001 00:00:00 +0000

Info

Summary: this page describes how to configure the automatic UTF-8 conversion feature available in Console ≥ 2.9.

Introduction

When source code is delivered in CAST Console and this source code contains characters whose encoding or character set is not UTF-8, this can cause problems during the analysis phase. CAST Console (when using the **[Workflow

Application onboarding with Fast Scan](/export-v2/onbrd/workflow-application-onboarding-with-fast-scan/)**) will warn you that the source code contains non UTF-8 encoded charactersand provide a list of the files impacted - see **[2.9
Onboarding with Fast Scan - redesigned job progress screen](/export-v2/aipconsole/release-notes/previous-releases/2-9/2-9-onboarding-with-fast-scan-redesigned-job-progress-screen/)**:

Alert in the Job Progress panel

Configuring the maximum number of parallel job executions per AIP Node

Mon, 01 Jan 0001 00:00:00 +0000

Info

Summary: this page describes how to configure the maximum number of parallel job executions that Console can perform per Node.

Introduction

By default, Console will be configured (using the threadPoolSize parameter) to run a maximum of two (2) jobs in parallel on each Node. A job is any type of execution using Console, for example:

run analysis
generate snapshot
source code delivery
etc.

Info

Executions that are not deemed as jobs and which are therefore not covered by the threadPoolSize parameter are:

Configuring start up services and scripts for use with Java 17 and above

Mon, 01 Jan 0001 00:00:00 +0000

Note

This documentation is valid only for Console/Nodes ≤ 1.27.0. All more recent 1.x and ≥ 2.x releases support Java ≥ 17 out of the box.

Introduction

Java 17+ is more restrictive regarding java library use and limits some elements to specific modules that are not enabled by default. As a result of this, although supported for use with Console, the Microsoft Windows Service installation scripts and the start up batch/script files delivered with the installer for the Console front-end and back-end Node must be modified before they can be used to launch or install Console or a Node:

Configuring SQL validation

Mon, 01 Jan 0001 00:00:00 +0000

Introduction

Out of the box in Console ≥ 1.27.1 and ≥ 2.1.0, SQL validation (to check for syntax errors) is disabled for the following features:

Creating query jobs in Application - Config - Update Application schema
Creating Explicit Filter queries for User Defined Modules in Application - Config - Modules

Therefore, when you save the job or explicit filter, no check is made to ensure that the SQL is valid. This could result in a job failure when the job is run, if the SQL is not valid. If you need to enable SQL validation, you can do so as follows:

Configuring unanalyzed alert thresholds

Mon, 01 Jan 0001 00:00:00 +0000

Info

The instructions below are specifically for Console****2.9. In Console ≥ 2.10, the thresholds are configured in the Admin Center - see **Administration Center - Settings - Alert Settings.**If you have set custom values for these thresholds using the method described below and you action an in-place upgrade to a more recent release of CAST Console, the custom values will be lost and you will need to re-set them using the UI in the Admin Center.

Customizing the dashboard context names

Mon, 01 Jan 0001 00:00:00 +0000

Info

Summary: this page describes how to customize the dashboard context names to match your own needs.

Note

This documentation is valid only for Console 1.x.

Overview

By default, the integrated CAST dashboards (Health and Engineering) are configured with the following names, which feature in the access URLs from the relevant icon depicted in the table below:

	Name	URL
	engineering	http[s]://<aip_console>:/engineering/index.html
	portal	http[s]://<aip_console>:/portal/index.html

It is possible to change these context names as follows:

Disabling automatic backup during Application and schema upgrade

Mon, 01 Jan 0001 00:00:00 +0000

Note

This documentation is valid only for Console ≥ 2.5.

Introduction

When performing an application / schema upgrade as described in Application and schema upgrade using AIP Console, a backup of the Application’s Management, Analysis and Dashboard schemas and the delivery folder is performed automatically and the backup stored in Administration Center - Applications - Application Details. If you want to disable this backup process (perhaps because the backup duration is very long or you do not have enough free disk space), you can do so as described below. CAST does not recommend disabling this automatic backup - please ensure that you have other means to roll back if an error occurs during the application / schema upgrade process.

Installing and uninstalling Windows Services

Mon, 01 Jan 0001 00:00:00 +0000

Info

Summary: Instructions explaining how to manually install and uninstall the Windows Service for Console and Node(s) packages.

Manually install the Windows Services

In some circumstances it may be necessary to manually install the Windows Service for the Console (1.x only) and Node packages, for example if you have previously been using the batch files to start and stop Console/Node. To do so, on the **server hosting the front-end Console (1.x only)**and on each Node where you require a Windows Service, locate the following files:

Managing Project Exclusion Rules

Mon, 01 Jan 0001 00:00:00 +0000

Info

Summary: this page describes how to manage Project Exclusion Rules.

Introduction

Most official CAST “discoverers” (the tools used to determine automatically which projects exist in delivered source code and therefore which Analysis Units will be created in Console for determining the analysis perimeter) include Project Exclusion Rules. These rules are used to determine what Console should do when certain conditions are met - take for example the following rules which aim to prevent multiple projects from being “discovered” for the same source code:

Modifying the Apache Tomcat temp folder for each AIP Node

Mon, 01 Jan 0001 00:00:00 +0000

Info

Summary: This page describes how to modify the location used for the Apache Tomcat related temp folder for each Node. This action is not required for normal functioning of Console and is therefore only something to be done in specific circumstances (described below).

Note

This documentation is valid only forConsole 1.x.

Introduction

Console uses Apache Tomcat as the back end engine to power its required functionality. For each Node package that is installed, an Apache Tomcat temporary folder is created in the following location:

Path matching option for source code delivery rescan

Mon, 01 Jan 0001 00:00:00 +0000

Info

Summary: this page describes how Console automatically detects missing packages in the new source code, when working in rescan mode (i.e. delivering a new Version - Vn+1).

Note

The path matching feature has been removed in Console ≥ 2.10 and the popup will no longer be triggered. This change means that for each new scan a brand new “version” is now created, instead of a “clone version” action. In turn this means that any customization set at Analysis Unit level will be lost and will need to be re-configured.

Update Health Dashboard configuration after Measurement Service schema changes

Mon, 01 Jan 0001 00:00:00 +0000

Info

Summary: this page describes how to update the Health Dashboard configuration after changing the name of your Measurement Service schema or the host PostgreSQL instance (as described in Administration Center - Settings - Measurement).

Note

This documentation is valid only for Console 1.x.

Following a name change only

If you have only changed the name of the Measurement Service schema, use the following steps:

Step 1

Open the following file in a text editor - this file is located on the server that is hosting the CAST RESTAPI that is managing your dashboard integration:

Using the aip-encryption-tool to encrypt credentials

Mon, 01 Jan 0001 00:00:00 +0000

Info

Summary: this page describes how to use the aip-encryption-tool to encrypt credentials stored in properties files and database schemas.

Note

This information is valid for ≥ 1.11.x releases of CAST Console.

Introduction

When installing and configuring Console, sometimes credentials need to be stored in .properties files or database schemas, for example:

Node access to PostgreSQL
Node access to CAST Extend
Configuring email notifications

Credentials that are input into installation wizards are automatically stored in encrypted format to avoid security issues, for example the following shows the credentials for PostgreSQL instance encrypted in the relevant schema (this example shows Console ≥ 2.x:

Post Java JDK upgrade steps

Mon, 01 Jan 0001 00:00:00 +0000

Note

This documentation is valid only for Console 2.x on Microsoft Windows.

Overview

After upgrading the Java JDK (for example to a new service pack or even a new minor or major release) installed on your machine or machines used by CAST AIP Console, there are some additional steps required, specifically for your CAST AIP Console installation. These steps are described below.

Update your %JAVA_HOME% system environment variable

Ensure that your %JAVA_HOME% system environment variable points to the new location of your Java JDK installation by using the Microsoft Windows built in Environment Variable editor which can be accessed by searching for “Edit the system environment variables”: