Customizing dashboard tiles

Overview

The default configuration and layout of tiles in all three dashboards (Management, Engineering and Security) is predefined, but this can be changed if your organization needs to display specific types of tiles, or change the data within the tiles.

Customizing the tiles involves updating .json files in which the tile configuration is defined. This is explained below.

What each dashboard’s tiles can contain is a reference in its own right, and the two sets have nothing in common:

Management tiles - the plugins available in cmp.json and app.json.
Engineering tiles - the tile types available in the Engineering and Security dashboards.

Step 1 - Locate the .json tile configuration files

The tile configuration files are located in the following folder on disk post-installation:

%PROGRAMDATA%\CAST\Imaging\CAST-Imaging-Dashboards\config\hd
%PROGRAMDATA%\CAST\Imaging\CAST-Imaging-Dashboards\config\ed
%PROGRAMDATA%\CAST\Imaging\CAST-Imaging-Dashboards\config\sd

The tile configuration files are stored in the dashboards container and are not made available in a mapped local volume. As such, you will need to alter the configuration of the container to expose the required files locally:

Copy (from the container) the folder containing the .json files to a local folder of your choice, for example, to copy them to a folder called config in the current folder, run:

$ sudo docker cp dashboards:/app/resources/config ./config

Edit your docker-compose.override.yml file (create it if it does not already exist) in the following location:

/opt/cast/installation/imaging-dashboards

Add a volumes entry to the dashboards service, pointing to a folder called config in the current folder (the container will expect the folder to be located in /opt/cast/installation/imaging-dashboards/config/):

services:
    dashboards:
        volumes:
            - ./config:/app/resources/config

Copy the files you extracted from the container to the location defined in the docker-compose.override.yml:

cp -r ./config/* /opt/cast/installation/imaging-dashboards/config/

On Podman, the steps are the same with podman cp in place of docker cp. The Compose command depends on the provider installed in your environment - it may be podman compose or podman-compose. The paths are the same on both platforms.

Step 2 - Update and customize

The following files can be updated and customized as you require:

\config\hd\app.json - used to define the single-application landing page (displayed when one application is present in the "general_measure" schema or when drilling down from the multi-application page)
\config\hd\cmp.json - used to define the multi-application landing page (displayed when more than one application is present in the general_measure schema)
\config\hd\app-ISO.json - as above, but specifically for the ISO-5055 view
\config\hd\cmp-ISO.json - as above, but specifically for the ISO-5055 view

config\ed\ed.json

config\sd\ed.json

Step 3 - Restart the dashboard services to ensure the changes are accepted

Restart the CAST Imaging Dashboard Microsoft Windows service.

Restart the dashboards container:

$ cd /opt/cast/installation/imaging-dashboards/
$ docker compose up -d

On Podman, run podman compose up -d (or podman-compose up -d, depending on the Compose provider installed) from the same folder.

Management Dashboard tiles

The tile types available in the Management Dashboard and the parameters each takes

Engineering and Security Dashboard tiles

The tile types available in the Engineering and Security dashboards and the parameters each takes