Email notifications

Available in ≥ 3.5.4-funcrel

Overview

Users can be notified via email with regard to the following “job” related statuses:

job successfully completed
job failed due to an error
user manually stopped a job
application creation successful
new version created
etc.

Email notifications (when enabled for a given user) are sent to users with permission to manage an application i.e. users with the following roles:

Administrator
Application Owner

What does a notification email look like?

An example notification email is shown below:

How do I enable email notifications?

Enabling email notifications is a two step process:

Step 1 - configure the mail server settings

In order for email notifications to be sent by CAST Imaging, a SMTP compatible mail server is required. This can be located on premises or can be external to the organisation (such as Microsoft 365). Then, a configuration file needs to be updated which defines where the SMTP is and the various SMTP related options that are required. The following fields are available in the configuration file and need tailoring to your SMTP server:

Microsoft Windows parameter	Docker/Podman parameter	Description
`spring:mail:host:`	`SPRING_MAIL_HOST=`	The host name (local server/fully qualified domain name) of your target mail server. For example, for an external Microsoft 365 mail server: `mycompany-com.mail.protection.outlook.com`.
`spring:mail:port:`	`SPRING_MAIL_PORT=`	The port number used by the target mail server to accept mail. For example: `587` (assumes STARTTLS) or `25` or `465`.
`spring:mail:username:` / `spring:mail:password:`	`SPRING_MAIL_USERNAME=` / `SPRING_MAIL_PASSWORD=`	The credentials required to access your target mail server. If no credentials are required (for example you are using Direct Send or a Connector in Microsoft 365) then leave these entries blank and set `properties:mail:smtp:auth` to `false`. A plain text password (not recommended) or an encrypted password that has been encrypted with the `aip-encryption-tool` available in `%PROGRAMFILES%\CAST\Imaging\CAST-Imaging-Analysis-Node\admin` (Microsoft Windows) or `installer/tools` (Docker/Podman unzipped installation media) are accepted.
`properties:mail:smtp:auth:`	`SPRING_MAIL_PROPERTIES_MAIL_SMTP_AUTH=`	Set by default to `true`. Set to `false` if your SMTP server does not require authentication.
`properties:mail:smtp:starttls:enable:`	`SPRING_MAIL_PROPERTIES_MAIL_SMTP_STARTTLS_ENABLE=`	Set by default to `true`. Set to `false` if your SMTP server does not require STARTTLS.

To configure your chosen mail server, follow the OS specific instructions:

Microsoft Windows

Edit the following file:

%PROGRAMFILES%\CAST\Imaging\CAST-Imaging-Control-Panel\application.yml

Locate the following section and configure each entry to match your SMTP server:

spring:
    mail:
        host: 
        port: 
        username: 
        password: 
        properties:
            mail:
                transport:
                    protocol: smtp
                smtp:
                  auth: true|false
                  starttls:
                    enable: true|false

Restart the CAST Imaging Control Panel Microsoft Windows services to ensure that the new settings are applied.

Linux via Docker/Podman

Create or re-use an existing file called docker-compose.override.yml (see Managing docker-compose.yml files) and add in and configure the following entries within the services:control-panel:environment section to match your SMTP server:

services:
  control-panel:
    environment:
      - SPRING_MAIL_HOST=
      - SPRING_MAIL_PORT=
      - SPRING_MAIL_USERNAME=
      - SPRING_MAIL_PASSWORD=
      - SPRING_MAIL_PROTOCOL=smtp
      - SPRING_MAIL_PROPERTIES_MAIL_SMTP_AUTH=true|false
      - SPRING_MAIL_PROPERTIES_MAIL_SMTP_STARTTLS_ENABLE=true|false

Restart the imaging-services service to ensure that the new settings are applied:

cd /opt/cast/installation/imaging-services
sudo docker compose down
sudo docker compose up -d

Step 2 - update UI option

Each user who would like to receive email notifications must tick the I want to receive email notifications option in the Profile settings: