September 2021 Dashboard Release Notes


Release Name - pi.2021-09-30

Release Date - Oct 6, 2021


We are pleased to present our latest offering of pi - our September 2021 release! This page helps summarise and familiarise you with the changes we have made, and is supported (where applicable) with useful videos to help explain the changes we have delivered.

Dec 13, 2021 - in response to a Java security vulnerability around Log4J2, this version of the dashboard needs to be updated to a version from our patched November 21 (inclusive) - or mitigating actions taken to provide security assurances - more information can be found HERE

Before upgrading, we recommend taking a backup. You can find more information here.

Known Issue

If you have the scheduler running and your AppPort is on the default port: 8224 and you then go and change it to something else and try to run the scheduler again, it will fail.

The workaround for this is to update the AppPort to whatever you desire, click Apply & Run, then remove the services and then Apply & Run again. This will allow you to schedule with a AppPort which is different from the default.

 

Here’s what we’ll cover;

 


Added

 

Ability to limit the number of external emails on Schedule (Zendesk#14471,14641)

Area of Dashboard

When creating new licences we can control the number of external email addresses that a dashboard can schedule emails to.
The following behaviours have been applied.

  • Max external emails: value. If the number of external email addresses added in the Schedules section of the dashboard is lower or equal to the specified figure, the schedule will send to the external emails. You will also be able to add additional external email addresses until the specified value is reached. Once the specified value is exceeded, the scheduler will not send emails to external email addresses and users will not able to add additional email addresses

  • Max external emails: not present in licence. The scheduler and the system allows the user to send to infinite amount of external email addresses

This change applies to external email addresses entered into the ‘Email Addresses’ section of the Schedules screen.

 

Extra CSS styles added for Category Objects Top Panel (Zendesk#16428)

Area of Dashboard

Three new style options have been added to the Themes>Style>Dashboard section of Dashboard Configuration which can be used to change the appearance of the Category Objects panel when it’s positioned at the top of the page.

.pi-style__category-objects-top-panel .section-panel__subhead {}
.pi-style__category-objects-top-panel .category-object-button-panel {}

.pi-style__category-objects-top-panel .section-panel__body {}

Please have a look at this section for more information on how these options can be used.

 

Theme editor CSS Validation (Zendesk#13000)

Area of Dashboard

When invalid CSS is entered in the Themes>Style section of Dashboard Configuration, a red exclamation mark will be displayed. When hovering over this a message will be displayed explaining the incorrect CSS. Users will be prevented for saving changes to this area of the dashboard until the invalid formatting has been corrected.


Changed

Improvements to OpenID Connect (Zendesk#13703)

Authentication

You can now configure a custom claim name for the email address in OpenID Connect configuration if the claim in your JWT token does not match the expected default. In addition, error handling for non-OpenID Connect tokens has been improved and list formats are now supported in the JWT in addition to pure string formats.

 

Replace NSSM with another service wrapper (Zendesk#15657)

Dashboard Deployment

Removed NSSM service manager and replaced it with Apache Commons Daemon in order to improve the reliability of the dashboard services installation, running and removing on Windows OS. As a result of this move, there are a few changes within the file structure on the installed dashboard, please see the below for reference:-

Added:

%BASE_DIR%/Dashboard/service - a new service folder contains the scripts and executable files for Apache Commons Daemon. The folder will contain the files listed below:

  • install_jvm_service.bat (used to install Tomcat)

  • install_exe_service.bat (used to install all other services)

  • remove_service.bat

  • prunsrv.exe

  • prunmgr.exe

  • NOTICE.txt & LICENSE.txt

Removed:

%BASE_DIR%/Dashboard/nssm - NSSM folder and its content

%BASE_DIR%/SafeStop.bat

%BASE_DIR%/StartTheServer.bat

%BASE_DIR%/StopTheServer.bat

The files below have also been removed across all dashboard modules:

fwenv.exe

install & remove service .bat scripts


Fixed

 

Create a v2 API wrapper for the internal Export Chart endpoints (Zendesk#14724)

API

We have implemented API endpoints for different types of chart download:

  • json

  • excel

 

Convert data to its defined type when getting the data fails (Zendesk#16776,16818,16842)

Data Connections

We use specific methods to get data, if any of these methods fail we will use getString. Any numeric measures that this affects will be converted from a string back to the correct data type.

 

Freeform JDBC should not set parameters when they're configured with 0/blank values (Zendesk#17795)

Dashboard Configuration

When establishing a connection using the FREEFORM JDBC driver, any optional details that need to be set will only be set if the fields are not 0/blank.

 

Updating a user via the API breaks the database connection (Zendesk#16313)

API

When updating a user via the API, the User Variables were not being updated on the respective cache which caused the database connection to break.

 

'Last day of the month’ schedules (Zendesk#17827)

Scheduler

The scheduler now saves and schedules when a recurrence has been created for the ‘last day of the month’.


Keeping An Eye On pi