Versions Compared

Key

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

...

Info

We have several ways that you can get hold of the latest release - see our Download Options page for more details.

Before upgrading, we always recommend that you review ALL release notes, from the version you are considering upgrading from and to. This is essential should there be a material change that could impact you or your customers. We always advise that you take a backup of your repository before beginning an upgrade , and recommend testing out the new software on a test environment first.

...

Here is what is included in the release.

Table of Contents

...

Product Release

Added

...

Automatic removal of log files based upon a new setting

...

#1883

...

25355 & 26671

...

Logging

Tomcat logs can now be set up to automatically be removed after a certain number of days. This behaviour is governed by a new setting available:

  • Under the Tomcat tab of the Configuration-Tool GUI under a new ‘Logging’ section (see picture below)

  • Under the Tomcat > Logging section of the dashboard.json file

  • Set via the PI_TOMCAT_LOGGING_MAX_AGE environment variable

...

This new setting also dictates the turnover of a new, daily rotating log file name out.{date}.log. This new file is where log messages from the Dashboard are written. The default value for this setting is 0 which means that no logs will be removed.

Info

Removal of log files older than the currently set limit occurs either when the Dashboard is restarted or when that file is rotated due to being written to on a new day meaning that it is possible for ‘outdated’ files to still be present within the directory

Setting drill start and end level

‘Drill to top on full screen close' Chart Attributes option now supports 'Drill to Chart’

#2054

28024 & 25474

Drill Down

The ‘Drill to top on full screen close’ option (introduced in our September 23 release) now supports the ‘Drill to Chart’ option.

Now, once this option or the related ‘Full screen to display this level’ are set to True that drill level and any below it will reflect that behaviour - even if you have drilled to another chart.

The two fields are now independent of one another. When editing a chart, you will be able to tell when a drill level has one/both settings overridden by a higher drill level as they will be disabled, appear as checked, and a warning icon with a helpful, on-hover tooltip will be displayed next to them.

Info

Please note, the field appearing as checked when disabled does not relate to its value in the database it is a visualisation of the expected behaviour.

...

Setting drill Start and End levels when embedding a chart

#1892

26827

Embedding

It is now possible to set a start Start and end End drill level that a user can see when looking at viewing a chart - when it is embedded. For instance in

As an example, where a chart with has 5 drill levels, it would be possible to have some users that can see levels 2-4. When skipping the top levels, no filter will be applied to the chart that is seen by the user.

You can set the values for drillStart and drill End drillEnd as query parameters on the url URL that you are using to embed.

When setting a drillStart you will also need to supply the identifiers for the chart and hierarchy levels of the drill levels above the start, and the drill level you wish the user to see by manipulating the URL directly.

These must be separated by the !$! delimiter when adding multiple levels. When drilling to the top, the user will return the the level defined as the drillStart parameter. It is possible to use the parameters individually or together.

...

The functionality will also work for dynamic drill conditions.

Info

The below url URL would allow the user to see drill levels 1, 2 and 3 (i.e the 2nd, 3rd and 4th hierarchy levels) of the chart:

http://localhost:1234/pi/chart/?drillStart=1&drillEnd=3#chart-filter/251__1/d-f-p=251__0/!$!251__1

*Location and syntax of the query parameters.

*Example of identifiers added to view level 1 (2nd hierarchy level) of the given chart.

Further documentation on restricting drill levels when embedding charts can be found here.← THIS LINK CURRENTLY LINKS TO A DRAFT. THE DRAFT WILL NEED TO GO LIVE BEFORE THE RELEASE NOTES GO OUT.on our Embedding pages.

 

Automatic removal of Tomcat log files based upon a new setting

#1883

25355 & 26671

Logging

Tomcat logs can now be set up to automatically be removed after a certain number of days. This behaviour is administered by a new setting that can be defined within;

  • Under the Tomcat tab of the Configuration-Tool GUI under a new ‘Logging’ section (see picture below)

  • Under the Tomcat > Logging section of the dashboard.json file

  • Set via the PI_TOMCAT_LOGGING_MAX_AGE environment variable

...

This new setting also dictates the turnover of a new, daily rotating log file name out.{date}.log.

This new file is where log messages from the Dashboard are written. The default value for this setting is 0 which means that no logs will be removed.

Info

Removal of log files older than the currently set limit occurs either when the Dashboard is restarted or when that file is rotated due to being written to on a new day meaning that it is possible for ‘outdated’ files to still be present within the directory

Redis support for session storage

#2003

Platform

-

Scaling

To enhance our scaling capabilities, we now have support for using Redis to store session data. This allows you to run multiple Dashboard instances in a load balanced environment with a single, fast store of session data.

To see how to use this have a look at our documentation and docker-compose example -

NEIL TO ADD EXAMPLE DOCKER COMPOSE AND DOCS

...

‘Drill to top on full screen close' Chart Attributes option now supports 'Drill to Chart’

...

#2054

...

28024

...

Drill Down

The ‘Drill to top on full screen close’ option added last month didn’t support ‘Drill to Chart’. Now, once this option or the related ‘Full screen to display this level’ are set to True that drill level and any below it will reflect that behaviour - even if you have drilled to another chart.

The two fields are now independent of one another. When editing a chart, you will be able to tell when a drill level has one/both of these settings overridden by a higher drill level as they will be disabled, appear as checked, and a warning icon with a helpful, on-hover tooltip will be displayed next to them. Please note, the field appearing as checked when disabled does not relate to its value in the database it is a visualisation of the expected behaviour.

...

 

 

The configuration for this is done via environment variables or in the configuration tool, and you can choose no session sync, tcp session sync which uses Tomcat’s built in sync or Redis where the session storage is fully offloaded to Redis.

This is configured via the configuration tool (Windows, Linux) or environment variables (containers).

For environment variable usage the following variables are required:

  • PI_TOMCAT_ENABLE_SESSION_SYNC: "true"

  • PI_TOMCAT_SESSION_SYNC_MODE: redis

  • PI_TOMCAT_SESSION_SYNC_REDIS_HOST: REDIS_HOST

  • PI_TOMCAT_SESSION_SYNC_REDIS_PORT: 6379

  • PI_TOMCAT_SESSION_SYNC_REDIS_PASSWORD: REDIS_PASSWORD

Improved error handling in the Scheduler service

#25885

-

Scheduling

Error handling for the scheduler service has been improved to better direct you to issues when a schedule is not sending correctly. The scheduler will now correctly inform you of the following issues:

  • Attached chart having an issue with a data connection.​

  • Attached chart having a SQL error.​

  • User doesn't have permission to view an attached chart.​

  • Failure associated with saving attachments to a directory.​

  • "Other" chart specific errors.

...

Changed

Container images rebased and updated, to fully maintained versions

deployment#62

-

Containers

To resolve reported vulnerabilities in the base used for our container images, all supported images have been either updated or rebased and updated to resolve these issues. As a result of using more lightweight base images over 150 MiB has been saved from the images.

 

Driver Update - Athena

driver updated

deployment#81

-

Dependencies

The Athena JDBC driver (provided by Amazon) has been upgrade updated to remove some address reported vulnerabilities.

 

Various library upgrades

3rd Party Library Update - JDom, AWS Marketplace & JAVA SAML

#2042

-

Dependencies

Libraries

JDom, AWS Marketplace and Java SAML libraries have been upgraded to resolve reported vulnerabiltiesremain updated with the latest features, and to address reported vulnerabilities.

...

Fixed

Incorrect label for

category

Category panel unpin

#2022

 -

Category Panel

The category Category panel unpin label had an incorrect label, this has been resolved, the wording has also been improved/description was incorrectly worded, which has been rectified as per the image below.

...

 

Embedding two categories in 1 html pages causes conflicts with the category mode

#1557

26883 & 23204

Area of Dashboard

...

Embedding

When embedding 2 categories in within 1 html page, with 2 different category modes, the category modes would conflict and you would get result in inconsistent behaviour where . The result being that sometimes it would wrongly incorrectly use the same category mode for both embedded categories. Now, each embedded category uses its defined mode correctly.

 

Failed to load time zone, defaulting time zone location to UTC

scheduler#64

25885 & 25900

Scheduler

Previously when When running the dashboard on Windows, the Scheduler was unable to pick up and use the correct time zone. This meant that the times in the monitoring screen were incorrect, and the scheduler logs would fill up with errors. This has now been fixed.

 

Resolved issue with encoding on url

Single Chart Mode - Encoding format URL feedback

#2065

 -

Embedding

The wrong An incorrect encoding format was being used on applied to the url URL feedback snack bar, when using single-chart mode. This has now been resolved The resolution helps improving both the security and user display user experienceexperiences.

...