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

General requirements

Hardware

Please see CAST AIP for Dashboards - Hardware requirements for more information.

Supported Application Servers for WAR file deployment

Application ServerSupported for 1.x WARSupported for 2.x WARNotes

Apache Tomcat 7.0.x 64-bit (where x ≥ 20)

(tick)(error)

Apache Tomcat is supported when installed on either Microsoft Windows or Linux.

Apache Tomcat 8.0.x 64-bit(tick)(error)
Apache Tomcat 8.5.x 64-bit(tick)(tick)
Apache Tomcat 9.0.x 64-bit(tick)
v. ≥ 1.17 only
(tick)
IBM WebSphere Application Server 8.5.x(tick)(error)Only supported when installed on a Linux Operating System - see Deployment on IBM WebSphere Application Server.

The CAST Dashboards are developed using the following Java specifications. This information will help you decide whether the web applications will function on an application server other than Apache Tomcat/IBM WebSphere Application Server:

Item1.x WAR2.x WAR
Servlet API3.03.1
Java88
Note that although the CAST Dashboards may function correctly on application servers other than those that are specifically supported (see above), CAST provides no official support for these application servers.

Supported Operating Systems

For ZIP/JAR file deployment

Operating SystemSupported
Microsoft Windows 2022(tick)
Microsoft Windows 10 Pro(tick)
CentOS 7.4(tick)

For WAR file deployment

Supported operating systems are those supported by the application server, typically Apache Tomcat.

Supported Java JRE/JDK

Whether you are installing CAST Dashboards using a WAR file for Apache Tomcat, or direct using the ZIP/JAR installations, a Java JRE or JDK must be installed on the host server. CAST only supports LTS releases as follows:

Java JRE / JDKSupported for 1.xSupported for 2.x
8 (LTS)(tick)(tick)
(error)(error)
10(error)(error)
11 (LTS)(error)(tick)
  • Java 11 (LTS) is only supported for CAST Dashboards ≥ 2.6.1 due to compatibility issues with the Lucene indexing system used in the Engineering Dashboard Advanced Search feature (see Managing the Engineering Dashboard search indexes).
  • A JAVA_HOME system environment variable is required and should be created automatically when the Java JRE is installed, but please ensure that this exists.

Supported Browsers

This section lists the browsers supported by CAST to connect to a dashboard:

BrowserSupportedDeprecated supportNotes
Microsoft Internet Explorer 9
(tick)
Microsoft Internet Explorer 10
(tick)
Microsoft Internet Explorer 11(tick)

Microsoft Edge(tick)
Minimum supported release: 40 and above

Mozilla Firefox

(tick)
Minimum supported release: 52 and above
Google Chrome(tick)
Minimum supported release: most recent only
Safari (iOS 10)(tick)
Only supported for the Health Dashboard

Deployment on Docker (Microsoft Windows or Linux)

See Standalone Dashboards for Docker deployment.

SoftwareRequiredNotes
Host Operating System(tick)

Microsoft Windows

Linux

  • Recommended Linux distributions:
    • all Linux distributions based on (or derived from) Red Hat

Third-party software required
for install on Docker (Linux and Windows)


(tick)

Docker on Linux

When using the Docker Installer extension

  • Docker Engine ≥ 18.0
  • docker-compose latest stable release
  • curl

Docker on Microsoft Windows

  • Docker Desktop for Windows - latest version recommended, or one that provides:
    • Docker Engine ≥ 19.03.5
    • docker-compose latest stable release
    • Hyper-V and WSL2 mode are both supported
    • Containers for Linux must be enabled

Note that when using Hyper-V mode for Docker Desktop only, the following must also be configured:

When using WSL2 mode, these changes are not required. Docker Desktop will automatically manage RAM memory and file sharing.

Engineering Dashboard requirements

(tick)

Java JRE/JDK

See Supported Java JRE/JDK above.

(tick)

Application Server

Only required when deploying a WAR file: must be installed on a compatible machine. See Supported Application Servers for WAR file deployment above.

(tick)

Web browser

Required for accessing the Engineering Dashboard.

(tick)

Dashboard schema

You can connect the Engineering Dashboard to one or multiple Dashboard schemas as follows:

Dashboard schema versionCompatible Engineering Dashboard
CAST AIP ≥ 8.3.16

≥ 1.12.0 (standalone)

≥ 1.5.12 (WAR delivered with CAST AIP ≥ 8.3.16)

CAST AIP < 8.3.16

1.12.0 (standalone)

1.5.12 (WAR delivered with CAST AIP < 8.3.16)

Each Dashboard schema must contain at least one snapshot.

(tick)

License KeyAccess to data in the Dashboard schema is governed by a license key - see Dashboard Service license key configuration. You must have a valid license key in your possession before you begin.
(tick)Roles/authorizations schema

Required only in ≥ 2.1.0-funcrel

In ≥ 2.1 only, an interface exists to manage User roles - 2.x and above and Data authorization - 2.x and above - this interface stores all its records in a dedicated schema on a CAST Storage Service/PostgreSQL instance. This instance does not need to be the same as used for your AIP schemas (Dashboard/Measure schemas), however, the required schema is small and therefore CAST recommends using an existing CAST Storage Service/PostgreSQL instance to host it. The schema is created automatically when you start up your Dashboard deployment if it does not already exist.

Health Dashboard requirements

(tick)

Java JRE

See Supported Java JRE/JDK above.

(tick)

Application Server

Only required when deploying a WAR file: must be installed on a compatible machine. See Supported Application Servers for WAR file deployment above.

(tick)

Web browser

Required for accessing the Health Dashboard.

(tick)

Measurement schema

A dedicated schema (the CAST Measurement Service) on a CAST Storage Service/PostgreSQL instance.

(tick)Dashboard schemas

You can consolidate data into the Measurement schema as follows:

CAST Dashboard Services

AIP releaseSupported
8.3.x(tick)
8.2.x(tick)
8.1.x(tick)
8.0.x(tick)
7.3.x(tick)
7.2.x(tick)
7.1.x(tick)
7.0.x(tick)
(tick)Roles/authorizations schema

Required only in ≥ 2.1.0-funcrel

In ≥ 2.1 only, an interface exists to manage User roles - 2.x and above and Data authorization - 2.x and above - this interface stores all its records in a dedicated schema on a CAST Storage Service/PostgreSQL instance. This instance does not need to be the same as used for your AIP schemas (Dashboard/Measure schemas), however, the required schema is small and therefore CAST recommends using an existing CAST Storage Service/PostgreSQL instance to host it. The schema is created automatically when you start up your Dashboard deployment if it does not already exist.

CAST-RESTAPI requirements

(tick)

Java JRE

See Supported Java JRE/JDK above.

(tick)

Application Server

Only required when deploying a WAR file: must be installed on a compatible machine. See Supported Application Servers for WAR file deployment above.

(tick)

Dashboard schema / Measurement schema

A single Dashboard schema or Measurement schema or multiple Dashboard / Measurement schemas.

When using the CAST-RestAPI with CAST Report Generator, CAST highly recommends configuring connections to the CAST Dashboard Service ONLY.

(tick)

License Key

Access to data in the Dashboard schema is governed by a license key - see Dashboard Service license key configuration. You must have a valid license key in your possession before you begin.

(tick)Roles/authorizations schema

Required only in ≥ 2.1.0-funcrel

In ≥ 2.1 only, an interface exists to manage User roles - 2.x and above and Data authorization - 2.x and above - this interface stores all its records in a dedicated schema on a CAST Storage Service/PostgreSQL instance. This instance does not need to be the same as used for your AIP schemas (Dashboard/Measure schemas), however, the required schema is small and therefore CAST recommends using an existing CAST Storage Service/PostgreSQL instance to host it. The schema is created automatically when you start up your Dashboard deployment if it does not already exist.

  • No labels