Created by James Hurrell, last modified on Jan 05, 2022


Summary: describes how to ensure that the Console and all Nodes are running.

Step 1: Start Node back-end package(s)

Ensure the Node back-end packages you have installed on dedicated Nodes are running, otherwise the Console package will complain that it cannot access them. This should be done regardless of whether you are using a single machine or a multi-node deployment scenario. To launch the Node back-end package, you can do any of the following. You will need to do this on EACH Node where you have installed the Node package.

MethodNotes

If it is not already running, start the Windows Service (Console ≥ 1.10.0 and AIP Core ≥ 8.3.13):

If you have chosen to install the Node package as a Windows Service, then CAST recommends using this method.

Use the shortcut on your desktop or in the Windows start menu.

These two methods should only be used if you have not chosen to install the Node package as a Windows Service.

The Node package will start in a CMD window. Check to ensure that you see the line "Started Application" as shown below highlighted in red (click to enlarge):

  • The CMD window must be kept open to keep the Node package running.
  • You may be prompted to allow the application through the Windows firewall - click Allow access:

  • If you click in the CMD window once the package is running, be aware that this may unintentionally pause the package. This is due to the default settings in Windows for the CMD windw where clicking anywhere in the CMD window changes it into "selection" mode and pauses the running application. To resolve the issue:
    • tap the ESCAPE key to change the CMD window back to normal mode - this will start the package again
    • consider changing the CMD defaults to avoid this issue altogether - right click the CMD window toolbar and select Defaults. Then untick QuickEdit Mode in the Options tab:

Run (i.e. double click) the following batch file:

%PROGRAMFILES%\CAST\AipConsole\AipNode\tools\runAipNode.bat


If the package fails to start, you can check the error logs here (see also AIP Console - Logging mechanisms):

%PROGRAMDATA%\CAST\AipConsole\AipNode\logs\cmsapi_error.log

Step 2: Start the Console front-end package

Windows

To launch the Console front-end package, you can use any of the following methods:

MethodNotes

Start the Windows Service (Console ≥ 1.10.0):

If you have chosen to install the Console package as a Windows Service, then CAST recommends using this method.

Use the shortcut on your desktop or in the Windows start menu:

This will start the Console package in a CMD window. Check to ensure that you see the line "Started Application" as shown below highlighted in red (click to enlarge):

  • The CMD window must be kept open to keep the Console package running.
  • You may be prompted to allow the application through the Windows firewall - click Allow access:

  • If you click in the CMD window once the package is running, be aware that this may unintentionally pause the package. This is due to the default settings in Windows for the CMD windw where clicking anywhere in the CMD window changes it into "selection" mode and pauses the running application. To resolve the issue:
    • tap the ESCAPE key to change the CMD window back to normal mode - this will start the package again
    • consider changing the CMD defaults to avoid this issue altogether - right click the CMD window toolbar and select Defaults. Then untick QuickEdit Mode in the Options tab:

Run (i.e. double click) the following batch file:

%PROGRAMFILES%\CAST\AipConsole\AipConsole\tools\runAIPConsole.bat

If the package fails to start, you can check the error logs here (see also AIP Console - Logging mechanisms):

%PROGRAMDATA%\CAST\AipConsole\AipConsole\logs\webi_error.log

Linux

For Linux, the startup script is located here:

$HOME\CAST\AipConsole\tools\runAIPConsole.sh

Run this script in Terminal as follows:

./runAIPConsole.sh

This will start the Console package in Terminal. Check to ensure that you see the line "Started Application" as shown below highlighted in red (click to enlarge):

  • The Terminal window must be kept open to keep the Console package running.
  • If the package fails to start, you can check the error logs here (see also AIP Console - Logging mechanisms):
<data_folder>\AipConsole\logs\webi_error.log

Step 3: Test access to Console front-end

Browse to the following URL to check the front-end Console package is running. You may wish to check that access is possible from an unrelated machine on the internal network. Ensure you specify the correct server (change "server") and port number (which was configured during the front-end installation):

http://<server>:8081/ui/index.html

If the setup has been completed successfully, you will see the following wizard page in your browser:

Click to enlarge