Introduction

This panel provides the settings for controlling the CAST Extend configuration. CAST Extend is CAST's own repository of extensions and access to this for downloading new extensions is provided direct in Console (see Application - Extensions). When the UI Install Wizard is run during the installation process, settings must be provided for CAST Extend. These settings are displayed in this panel.

You can therefore use the panel to update the settings for CAST Extend, i.e. if you want to change the user name, or if you want to start using CAST Extend local server or CAST Extend Offline.

Available options

Extend website

When enabled, this mode configures each Node to connect to CAST's publicly available extension server (https://extend.castsoftware.com/) over the internet on port 443 via TCP.

In this mode, the CAST Extend URL field will be automatically populated with the CAST Extend URL (https://extend.castsoftware.com/) in read-only mode (i.e. the URL cannot be changed). You will then need to input your CAST Extend API key (this can be generated in the CAST Extend UI - see CAST Extend. Console will check that it can access Extend when you click Save.

  • If you do not have an account on CAST Extend, you can register for one, for free, using the following URL: https://extend.castsoftware.com/#/register
  • When upgrading to Console ≥ 1.25 with the Extend official service option already configured with a username/password, the API Key for your username will be fetched automatically by Console as part of the upgrade process.
Extend local server

When enabled, this mode configures each Node to connect to an on-premises deployment of CAST Extend local server, therefore avoiding a connection to CAST's publicly available extension server over the internet. See Install CAST Extend local server or Offline - optional.

Enter the URL of your on-premises CAST Extend local server, enter the API Key and then click Next to continue - Console will then check that it can access the on-premises CAST Extend Offline:

API Key

The API Key will have been generated during the installation of CAST Extend Proxy and is displayed in the final summary screen of the installer:

 

Alternatively you can find the API key in the following location on the server on which CAST Extend Proxy is installed:

C:\Program Files\CAST\Extend\config.proxy.json

The key is located on the line APIKEY:

{
  "PORT": 8085,
  "STORAGE_DIR": "c:/ProgramData/CAST/Extend",
  "PACKAGE_DIR": null,
  "LOG_DIR": "C:/Program Files/CAST/Extend/logs",
  "PUBLIC_URL": "http://WIN10TEST:8085/",
  "EXTEND_URL": "https://extend.castsoftware.com",
  "APIKEY": "XCGN1-9263B92E143984F6EF357684F7EFD3EE336C6E7A5F2278ADE1352D7BD34147FFC60F94920F90B9095EBDBD11",
  "USER": "",
  "CREDENTIALS": "CRYPTED2:A65B5035B193DB7B2B59221",
  "SYNC_TYPE": "auto"
}

Extension Package Upload

This section has been removed in Console ≥ 2.5. See Update CAST Extend local server with new content for alternative methods for uploading extension packages to Extend local server.

When configured, a new section will become visible allowing you to Update CAST Extend local server with new content:

Click to enlarge:

Synchronize Extensions

The Synchronize Extensions button is displayed when the connection settings are input and saved. This option will force CAST Extend Proxy (when running in online modeto fetch the extension "manifest" from CAST Extend - i.e. information that Console requires in order to request the correct extension:

  • available extensions
  • available releases
  • technology to extension mappings

This process is also automated (once per day) - see CAST Extend local server.

Extend offline service (deprecated)

CAST Extend Offline is deprecated and you should use CAST Extend local server instead.

When enabled, this mode configures each Node to connect to an on-premises deployment of CAST Extend Offline, therefore avoiding a connection to CAST's publicly available extension server over the internet. See Install CAST Extend local server or Offline - optional.

In this mode, the CAST Extend URL field will be empty and the CAST Extend Login (email) and CAST Extend Password fields will be hidden (no authentication is required for the on-premises CAST Extend Offline). Enter the URL of your on-premises CAST Extend Offline and then click Next to continue - Console will then check that it can access the on-premises CAST Extend Offline:

Extension Package Upload

This section has been removed in Console ≥ 2.5. See Update CAST Extend local server with new content for alternative methods for uploading extension packages to Extend local server.

When configured, a new section will become visible allowing you to Update CAST Extend Offline with new content:

Click to enlarge

Allow CAST to automatically collect anonymous statistical dataSee Administration Center - Settings - Allow CAST to collect anonymous statistical data automatically for more information about this option.

Technical information

Where are downloaded extensions stored?

.nupkg format

When Console fetches an extension from CAST Extend, the extension will initially be in .nupkg format. These files are stored in the following holding locations:

Console ≥ 2.x Enterprise%PROGRAMDATA%\CAST\AIP-Node\ExtendCliConfig\packages
Console ≥ 2.x Standalone%PROGRAMDATA%\CAST\AIP-Console-Standalone\ExtendCliConfig\packages
Console 1.x (≥ 1.25)

%PROGRAMDATA%\AipConsole\AipNode\ExtendCliConfig\packages

Console 1.x (≤ 1.24)%LOCAPPDATA%\NuGet\Cache

This folder can grow significantly over prolonged usage of Console and may need to be cleaned - it is safe to remove these files.

Installed format

When the extension is installed the .nupkg file is uncompressed and the extension is placed in %PROGRAMDATA%\CAST\CAST\Extensions.

Troubleshooting HTTPS connection issues

In some situations, an error may occur when trying to save the CAST Extend connection parameters - Error updating Extend Settings:

A similar error is also recorded in the Node log when a given Node attempts to access CAST Extend: Failed to connect to Extend Server caused by:

Caused by: javax.net.ssl.SSLHandshakeException: sun.security.validator.ValidatorException: PKIX path building failed: sun.security.provider.certpath.SunCertPathBuilderException: unable to find valid certification path to requested target 

This error usually occurs if the signing authority of the SSL certificate used by CAST Extend is not listed in the Java JRE cacerts file located at %PROGRAMFILES%\CAST\<release>\jre\security\cacerts on the Node. Resolving the issue involves importing the required SSL certificates into the Java JRE delivered with AIP Core - this is out of the scope of this document, but some tips can be found in SSL Errors - PXIX path building failed - How to import certificate into JRE/JDK.