Page tree

Versions Compared

Key

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

...

(tick)Upgrade processThe upgrade process is a "side-by-side upgrade". This means that the new dashboard WAR/ZIP file should be deployed alongside the existing WAR/ZIP file and any settings transferred from the existing to the new.
(tick)Where to run the upgrade?

The process must be run on the host server.

(tick)Obtain the installation media

Download the latest release of the required CAST Dashboard from CAST Extend. This media contains:

  • a WAR file for deployment on Apache Tomcat (1.x releases)
  • a ZIP file for deployment without Apache Tomcat (≥ 2.x releases)
(tick)Access to a CAST Storage Service/PostgreSQL instance (≥ 2.1)

When upgrading to ≥ 2.1 a graphical user interface has been implemented for managing the assignment of role and data authorizations to users and groups of users. This interface replaces the existing mechanism provided by the roles.xml and the authorizations.xml files. This new management interface relies on a schema hosted on a CAST Storage Service/PostgreSQL instance to store the roles/data authorizations. This schema is called cast_dashboards by default and will be created on first startup of the web application.

(tick)Stop all services

Before starting any upgrade process, you must ensure ALL services are stopped, for example stop Apache Tomcat or any existing Dashboards running in SpringBoot mode.

Anchor
WAR
WAR
Instructions for transitioning between 1.x WAR files with Apache Tomcat

...

1.x WAR file2.x WAR fileNotes
\META-INF\context.xmlDoes not exist. Use new sections in \WEB-INF\classes\application.properties.

Configuration has changed. Refer to the following documentation (Step 2) for more information:

\WEB-INF\authorizations.xml

\WEB-INF\classes\authorizations.xml

See Data authorization.

  • 2.0.x release - No change in configuration method. 
  • ≥ 2.1.0 release - authorizations.xml has been replaced with a graphical user interface to manage data authorizations for users/groups. Configuration is stored in a schema called "cast_dashboards" on a chosen CAST Storage Service/PostgreSQL instance. There are two choices for how to proceed:
    • You can provide your authorizations.xml file and on first start-up of the web application the authorizations will be automatically transferred into the management interface (i.e. the schema called "cast_dashboards"). The authoirzationsauthorizations.xml file will then be ignored on any subsequent web application startup and all changes from then on must be performed using the graphical interface.
    • You can assign the data authorizations from scratch using the graphical interface.
\WEB-INF\domains.properties\WEB-INF\classes\domains.properties

Configuration has changed. Refer to the following documentation (Step 2) for more information:

\WEB-INF\license.keyOnly for the Engineering Dashboard. This file will not exist in the new Dashboard and can therefore be copied over as is to: \WEB-INF\classes\license.keyNo change in configuration method. See Dashboard Service license key configuration.
\WEB-INF\license.xml\WEB-INF\classes\license.xmlNo change in configuration method. See Dashboard Service license key configuration and Data authorization.
\WEB-INF\log4j2.xmlDoes not exist. Use \WEB-INF\classes\log4j2-spring.xmlNo change in configuration method. See Configuring the Log and Audit Trail.
\WEB-INF\report.propertiesDoes not exist. Use equivalent section in \WEB-INF\classes\application.properties.No change in configuration method. See CAST Report Generator - CAST Report Generator for Dashboards.
\WEB-INF\roles.xml\WEB-INF\classes\roles.xml

See User roles.

  • 2.0.x release - No change in configuration method. 
  • ≥ 2.1.0 release - roles.xml has been replaced with a graphical user interface to manage role assignments for users/groups. Configuration is stored in a schema called "cast_dashboards" on a chosen CAST Storage Service/PostgreSQL instance. There are two choices for how to proceed:
    • You can provide your roles.xml file and on first start-up of the web application the role assignments will be automatically transferred into the management interface (i.e. the schema called "cast_dashboards"). The roles.xml file will then be ignored on any subsequent web application startup and all changes from then on must be performed using the graphical interface.
    • You can assign the roles from scratch using the graphical interface.
\WEB-INF\security.propertiesDoes not exist. Use equivalent section in \WEB-INF\classes\application.properties.Configuration has changed. Refer to the following documentation: User authentication.
\WEB-INF\users.properties\WEB-INF\classes\users.propertiesNo change in configuration method. See User authentication.
\engineering\resources\ed.jsonWEB-INF\classes\config\ed\ed.jsonIf you have made configuration changes to .JSON files to create custom tiles or layout and you want to retain those changes in the new version of the Dashboard, you can re-use old .JSON files with the new Dashboard, however, please note that doing so will mean that you will not benefit from any improvements or features added to the current release of the Dashboard.

\portal\resources\app.json

WEB-INF\classes\config\hd\app.json
\portal\resources\cmp.jsonWEB-INF\classes\config\hd\cmp.json
\portal\resources\internal\app-navigation.jsonDoes not exist (withdrawn in ≥ 1.23).-

...

By default, the CAST Dashboard 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 adminThis ensures that one user can access all data and configuration settings. This step is not required when using Dashboards 1.x and 2.0 and can be MUST be performed from the machine on which the dashboard is running, using the URL http://localhost:<port> - if you attempt it from another machine on the network, you will not be able to "become admin". See First login and become admin. This step is not required when using Dashboards 2.0 and can be skipped.

Instructions for transitioning between 1.x WAR file and 2.x ZIP file

...

1.x WAR file2.x ZIP fileNotes
\META-INF\context.xmlDoes not exist. Use new sections in <unpacked_zip>\configurations\application.properties.

Configuration has changed. Refer to the following documentation (Step 2) for more information:

\WEB-INF\authorizations.xml

<unpacked_zip>\configurations\authorizations.xml

See Data authorization.

  • 2.0.x release - No change in configuration method. 
  • ≥ 2.1.0 release - authorizations.xml has been replaced with a graphical user interface to manage data authorizations for users/groups. Configuration is stored in a schema called "cast_dashboards" on a chosen CAST Storage Service/PostgreSQL instance. There are two choices for how to proceed:
    • You can provide your authorizations.xml file and on first start-up of the web application the authorizations will be automatically transferred into the management interface (i. The authoirzations.xml e. the schema called "cast_dashboards"). The authorizations.xml file will then be ignored on any subsequent web application startup and all changes from then on must be performed using the graphical interface.
    • You can assign the data authorizations from scratch using the graphical interface.
\WEB-INF\domains.properties<unpacked_zip>\configurations\domains.properties

Configuration has changed. Refer to the following documentation (Step 2) for more information:

\WEB-INF\license.keyOnly for the Engineering Dashboard. This file will not exist in the new Dashboard and can therefore be copied over as is to: <unpacked_zip>\configurations\license.keyNo change in configuration method. See Dashboard Service license key configuration.
\WEB-INF\license.xml<unpacked_zip>\configurations\license.xmlNo change in configuration method. See Dashboard Service license key configuration and Data authorization.
\WEB-INF\log4j2.xmlDoes not exist. Use <unpacked_zip>\configurations\log4j2-spring.xmlNo change in configuration method. See Configuring the Log and Audit Trail.
\WEB-INF\report.propertiesDoes not exist. Use equivalent section in <unpacked_zip>\configurations\application.properties.No change in configuration method. See CAST Report Generator - CAST Report Generator for Dashboards.
\WEB-INF\roles.xml<unpacked_zip>\configurations\roles.xml

See User roles.

  • 2.0.x release - No change in configuration method. 
  • ≥ 2.1.0 release - roles.xml has been replaced with a graphical user interface to manage role assignments for users/groups. Configuration is stored in a schema called "cast_dashboards" on a chosen CAST Storage Service/PostgreSQL instance. There are two choices for how to proceed:
    • You can provide your roles.xml file and on first start-up of the web application the role assignments will be automatically transferred into the management interface (i.e. the schema called "cast_dashboards"). The roles.xml file will then be ignored on any subsequent web application startup and all changes from then on must be performed using the graphical interface.
    • You can assign the roles from scratch using the graphical interface.
\WEB-INF\security.propertiesDoes not exist. Use equivalent section in <unpacked_zip>\configurations\application.properties.Configuration has changed. Refer to the following documentation: User authentication.
\WEB-INF\users.properties<unpacked_zip>\configurations\users.propertiesNo change in configuration method. See User authentication.
\engineering\resources\ed.json<unpacked_zip>\configurations\config\ed\ed.jsonIf you have made configuration changes to .JSON files to create custom tiles or layout and you want to retain those changes in the new version of the Dashboard, you can re-use old .JSON files with the new Dashboard, however, please note that doing so will mean that you will not benefit from any improvements or features added to the current release of the Dashboard.


\portal\resources\app.json

<unpacked_zip>\configurations\config\hd\app.json
\portal\resources\cmp.json<unpacked_zip>\configurations\config\hd\cmp.json
\portal\resources\internal\app-navigation.jsonDoes not exist (withdrawn in ≥ 1.23).-

...

Info

Step 4 - First login and become admin - ≥ 2.1 only

By default, the CAST Dashboard 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. This step is not MUST be performed from the machine on which the dashboard is running, using the URL http://localhost:<port> - if you attempt it from another machine on the network, you will not be able to "become admin". See First login and become admin. This step is not required when using Dashboards 1.x and 2.0 and can be skipped.

Step 5 - Undeploy the existing WAR file (optional)

Undeploy the existing war file from Apache Tomcat - you can use Apache Tomcat manager to do this, or simply delete the relevant folder and file in CATALINA_HOME\webapps. This step is optional and you may wish to leave this in place until the new dashboard is fully tested and working.

Instructions for transitioning between 2.x ZIP files

To transition between 2.x ZIP files (for example 2.0.0 to 2.1.0) is relatively simple although there is no managed "upgrade" process.

Step 1 - Deploy the new .ZIP file

Obtain the new .ZIP file and unzip it to any location on the host server.

Step 2 - Configure your new Dashboard

You will now need to transfer the details of your environment (stored in the configuration files such as web.xml/context.xml/other .properties/.xml/.json files) from the old Dashboard to the new. Please be aware that you should not perform a merge or overwrite configuration files (unless specifically requested to do so in the instructions below) - instead you must manually update the new configuration files with the details from the old configuration files.

Use the following table to find the location of the configuration files:

2.x ZIP fileNotes
<unpacked_zip>\configurations\application.properties.

Refer to the following documentation for more information:

See also CAST Report Generator - CAST Report Generator for Dashboards.

<unpacked_zip>\configurations\authorizations.xml

See Data authorization - 2.x and above.

From 2.0.0 to ≥ 2.1.0 release

authorizations.xml has been replaced with a graphical user interface to manage data authorizations for users/groups. Configuration is stored in a schema called "cast_dashboards" on a chosen CAST Storage Service/PostgreSQL instance. There are two choices for how to proceed:

  • You can provide your authorizations.xml file and on first start-up of the web application the authorizations will be automatically transferred into the management interface (i.e. the schema called "cast_dashboards"). The authorizations.xml file will then be ignored on any subsequent web application startup and all changes from then on must be performed using the graphical interface.
  • You can assign the data authorizations from scratch using the graphical interface.

From ≥ 2.1.0 release

All authorization data is stored in the schema "cast_dashboards" and the authorizations.xml file is no longer used. CAST recommends re-using the "cast_dashboards" schema so that all existing authorizations are re-used. This is configured in the <unpacked_zip>\configurations\application.properties file.

<unpacked_zip>\configurations\domains.properties

Refer to the following documentation for more information:

Only for the Engineering Dashboard. This file will not exist in the new Dashboard and can therefore be copied over as is to: <unpacked_zip>\configurations\license.keySee Dashboard Service license key configuration.
<unpacked_zip>\configurations\license.xmlSee Dashboard Service license key configuration and Data authorization.
<unpacked_zip>\configurations\log4j2-spring.xmlSee Configuring the Log and Audit Trail.
<unpacked_zip>\configurations\roles.xml

See User roles - 2.x and above.

From 2.0.0 to ≥ 2.1.0 release

  • roles.xml has been replaced with a graphical user interface to manage role assignments for users/groups. Configuration is stored in a schema called "cast_dashboards" on a chosen CAST Storage Service/PostgreSQL instance. There are two choices for how to proceed:
    • You can provide your roles.xml file and on first start-up of the web application the role assignments will be automatically transferred into the management interface (i.e. the schema called "cast_dashboards"). The roles.xml file will then be ignored on any subsequent web application startup and all changes from then on must be performed using the graphical interface.
    • You can assign the roles from scratch using the graphical interface.

From ≥ 2.1.0 release

All roles data is stored in the schema "cast_dashboards" and the roles.xml file is no longer used. CAST recommends re-using the "cast_dashboards" schema so that all existing roles are re-used. This is configured in the <unpacked_zip>\configurations\application.properties file.

<unpacked_zip>\configurations\users.propertiesSee User authentication.
<unpacked_zip>\configurations\config\ed\ed.jsonIf you have made configuration changes to .JSON files to create custom tiles or layout and you want to retain those changes in the new version of the Dashboard, you can re-use old .JSON files with the new Dashboard, however, please note that doing so will mean that you will not benefit from any improvements or features added to the current release of the Dashboard.


<unpacked_zip>\configurations\config\hd\app.json
<unpacked_zip>\configurations\config\hd\cmp.json

Step 3 - Start the new Dashboard and check access

To start the dashboard, run the following file:

Code Block
<unpacked_zip>\startup.bat
<unpacked_zip>\startup.sh

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 dashboard. If you are testing on the server itself, you can use http://localhost:8080:

Code Block
http://<server_name>:8080


Info

Step 4 - First login and become admin

By default, the CAST Dashboard 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. This step MUST be performed from the machine on which the dashboard is running, using the URL http://localhost:<port> - if you attempt it from another machine on the network, you will not be able to "become admin". See First login and become admin.

Step 5 - Remove existing dashboard (optional)

Remove the existing Dashboard deployment if necessary. This step is optional and you may wish to leave this in place until the new dashboard is fully tested and working.