Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Windows ServiceInstall as a Windows Service

When unticked (default position), this option will NOT install the package as a Windows Service. If you want to install a Windows Service so that you can more easily stop and start the package, tick the option.

Start the service after installation

When ticked (default position) the Windows Service will be started after it is installed (recommended).

Info

Note that the service will be set to start automatically and will be running unless you have specifically disabled this option.


Log on as

By default, this option is unticked and the Local System account will be used to run the service, however, CAST does not recommend this and a warning will be displayed when you click Next:

If you would like to use a Service User account to run the service, tick the option and fill in the credentials:

Screen 7

Choose whether to create shortcut icons and Start menu entries for the package:

Image Removed

Screen 8

The installation process will start. Click Next when complete:

Image Removed

Screen 9

The installation process is complete:

Image Removed

CLI mode

The interactive console installer will then start. The steps for the installation process are similar to the GUI installation. Please refer to the GUI installation above for the list of required steps, parameters, default values, etc. Default values are indicated in square brackets ([like this]) and will be used if the input is not filled with a different value.

Image Removed

...

To start the dashboard:

  • either start the Windows Service if you are using Microsoft Windows and have chosen to install the Windows Service (and it is not already running)
  • or run the following file:
Code Block
Microsoft Windows
%PROGRAMFILES%\CAST\Dashboards\API\startup.bat

Linux
/root/CAST/Dashboards/API/startup.sh
Note that you may need to run "chmod +x startup.sh" to grant execution permission to the script before running it.
You may also need to run this file with elevated permissions (e.g. sudo) using the following syntax "./startup.sh"
Info
If you need to start the service automatically on Linux, you should consider creating a Linux service using systemd (available by default in the majority of main stream Linux distributions such as CentOS, Debian, Fedora, RHEL, SUSE and Ubuntu). This is beyond the scope of this document, however you may wish to read the following third party informationhttps://linuxconfig.org/how-to-automatically-execute-shell-script-at-startup-boot-on-systemd-linux.

By default the dashboard is configured to run on port 8080. Use the following URL - where <server_name> is equal to the host name of the current server to access the RestAPI. If you are testing on the server itself, you can use http://localhost:8080:

Code Block
http://<server_name>:8080

You should see the Rest Client page as follows - this indicates that the initial setup was successful:

Image Removed

Info

...


By default, the CAST RestAPI requires that at least one user is granted the ADMIN role following the first login after the User authentication configuration. This ensures that one user can access all data and configuration settings. See First login and become admin.

Warning

This action must be completed from the same machine where the RestAPI is deployed, i.e. using the URL http://localhost. This is a security mechanism and attempting this action from another host on the network will fail. Note that when using SAML authentication mode, the requirement to perform this action using the URL http://localhost is removed and can be performed from any machine.

...

As explained in Dashboard Service license key configuration, when you want to access a Dashboard schema using the CAST RestAPI (i.e. via the Engineering Dashboard, or via the CAST Report Generator), a special license key is required. This license key grants specific access to one or multiple Dashboard schemas for the web application in which it is installed (i.e. the Engineering Dashboard or the CAST RestAPI).

You must therefore install the license key and, if you are using a restricted license key, define data access authorization. These two steps are explained in Dashboard Service license key configuration in the sections How do I install a license key? and How to authorize users when using a RESTRICTED license key.

...

This step involves configuring roles for users and groups that are accessing the CAST RestAPI. See User roles.

...

Before your users can exploit data via the CAST RestAPI, you need to generate snapshot data and (if accessing a Measurement Service) ensure the snapshot data is uploaded to the Measurement schema.

...

This step involves configuring data Authorization. An authorization defines permission to a user or group of users to access and "consume the data" in a specific Application via the RestAPI. If permission is not granted then any information related to this Application will be not accessible: application properties such as name, technologies or grades and measures, etc. Therefore, an Authorization must be defined before a user/group of users can access a specific application. See Data authorization.

What is installed?

Files

All files are installed to the following locations unless you choose custom installation folders:

Code Block
%PROGRAMFILES%\CAST\Dashboards\<dashboard>
%PROGRAMDATA%\CAST\Dashboards\<dashboard>

/root/CAST/Dashboards/<dashboard>
/root/ProgramData/CAST/Dashboards/<dashboard>

Microsoft Windows service

On Microsoft Windows, an optional service can be created during the installation to allow you to stop/start the service as required. This service will be available in the services control panel:

Image Removed

Startup/shutdown scripts

Startup and shutdown scripts are available if you do not want to use a Windows Service or systemd (or equivalent) on Linux:

%PROGRAMFILES%\CAST\Dashboards\<dashboard>\startup.bat /root/ProgramData/CAST/Dashboards/<dashboard>\startup.sh /root/ProgramData/CAST/Dashboards/<dashboard>\shutdown.sh Note that you may need to run "chmod +x <file>.sh" to grant execution permission to the scripts before running them. You may also need to run this file with elevated permissions (e.g. sudo) using the following syntax "./<file>.sh"
Code Block
Info
  • The installer requires a JAVA_HOME system environment variable pointing to the installation location of the Java JDK on the host machine.
  • You can change the log on as, after the install has completed by right clicking the service and changing the options in the Log On tab:

Image Added

  • The installer will set the service to use the following RAM memory - you may find that this is not sufficient. See Apache Tomcat performance considerations for information about memory requirements.
    • Initial memory pool = 256MB
    • Maximum memory pool = 1024MB

Image Added

Screen 7

Choose whether to create shortcut icons and Start menu entries for the package:

Image Added

Screen 8

The installation process will start. Click Next when complete:

Image Added

Screen 9

The installation process is complete:

Image Added

CLI mode

The interactive console installer will then start. The steps for the installation process are similar to the GUI installation. Please refer to the GUI installation above for the list of required steps, parameters, default values, etc. Default values are indicated in square brackets ([like this]) and will be used if the input is not filled with a different value.

Image Added

Anchor
step3
step3
Step 3 - Start the dashboard and test connection

To start the dashboard:

  • either start the Windows Service if you are using Microsoft Windows and have chosen to install the Windows Service (and it is not already running)
  • or run the following file:
Code Block
Microsoft Windows
%PROGRAMFILES%\CAST\Dashboards\API\startup.bat

Linux
/root/CAST/Dashboards/API/startup.sh
Note that you may need to run "chmod +x startup.sh" to grant execution permission to the script before running it.
You may also need to run this file with elevated permissions (e.g. sudo) using the following syntax "./startup.sh"


Info
If you need to start the service automatically on Linux, you should consider creating a Linux service using systemd (available by default in the majority of main stream Linux distributions such as CentOS, Debian, Fedora, RHEL, SUSE and Ubuntu). This is beyond the scope of this document, however you may wish to read the following third party informationhttps://linuxconfig.org/how-to-automatically-execute-shell-script-at-startup-boot-on-systemd-linux.

By default the dashboard is configured to run on port 8080. Use the following URL - where <server_name> is equal to the host name of the current server to access the RestAPI. If you are testing on the server itself, you can use http://localhost:8080:

Code Block
http://<server_name>:8080

You should see the Rest Client page as follows - this indicates that the initial setup was successful:

Image Added

Info

Anchor
become_admin
become_admin
Step 4 - First login and become admin

By default, the CAST RestAPI requires that at least one user is granted the ADMIN role following the first login after the User authentication configuration. This ensures that one user can access all data and configuration settings. See First login and become admin.

Warning

This action must be completed from the same machine where the RestAPI is deployed, i.e. using the URL http://localhost. This is a security mechanism and attempting this action from another host on the network will fail. Note that when using SAML authentication mode, the requirement to perform this action using the URL http://localhost is removed and can be performed from any machine.

Anchor
step5
step5
Step 5 - Install the license key

As explained in Dashboard Service license key configuration, when you want to access a Dashboard schema using the CAST RestAPI (i.e. via the Engineering Dashboard, or via the CAST Report Generator), a special license key is required. This license key grants specific access to one or multiple Dashboard schemas for the web application in which it is installed (i.e. the Engineering Dashboard or the CAST RestAPI).

You must therefore install the license key and, if you are using a restricted license key, define data access authorization. These two steps are explained in Dashboard Service license key configuration in the sections How do I install a license key? and How to authorize users when using a RESTRICTED license key.

Anchor
step6
step6
Step 6 - Configure roles

This step involves configuring roles for users and groups that are accessing the CAST RestAPI. See User roles.

Anchor
step7
step7
Step 7 - Generate snapshot data

Before your users can exploit data via the CAST RestAPI, you need to generate snapshot data and (if accessing a Measurement Service) ensure the snapshot data is uploaded to the Measurement schema.

Anchor
step8
step8
Step 8 - Configure data authorization

This step involves configuring data Authorization. An authorization defines permission to a user or group of users to access and "consume the data" in a specific Application via the RestAPI. If permission is not granted then any information related to this Application will be not accessible: application properties such as name, technologies or grades and measures, etc. Therefore, an Authorization must be defined before a user/group of users can access a specific application. See Data authorization.

What is installed?

Files

All files are installed to the following locations unless you choose custom installation folders:

Code Block
%PROGRAMFILES%\CAST\Dashboards\<dashboard>
%PROGRAMDATA%\CAST\Dashboards\<dashboard>

/root/CAST/Dashboards/<dashboard>
/root/ProgramData/CAST/Dashboards/<dashboard>

Microsoft Windows service

On Microsoft Windows, an optional service can be created during the installation to allow you to stop/start the service as required. This service will be available in the services control panel:

Startup/shutdown scripts

Startup and shutdown scripts are available if you do not want to use a Windows Service or systemd (or equivalent) on Linux:

Code Block
%PROGRAMFILES%\CAST\Dashboards\<dashboard>\startup.bat

/root/ProgramData/CAST/Dashboards/<dashboard>\startup.sh
/root/ProgramData/CAST/Dashboards/<dashboard>\shutdown.sh
Note that you may need to run "chmod +x <file>.sh" to grant execution permission to the scripts before running them.
You may also need to run this file with elevated permissions (e.g. sudo) using the following syntax "./<file>.sh"

Uninstaller

...