Content Comparison

NEW FEATURES

Ability to define what languages are available and the names they display as in the Language Selectors

pi#2653

32809

Multilingual

You can now add a ‘languages.properties’ file into your locale directory to dictate what languages appear in the Language Selectors and under what name they are displayed. The presence of this file disables the auto-generation of languages from the ‘messages*.properties’ filenames and will not provide 'English' as a default. Languages in this file are defined by simple key/value pairs of the ‘language code’ and the display name separated by an equals sign e.g. to define the language associated with files with the ‘en_GB’ language code in their filename and have it appear as “British” in the Language Selectors I would have the following on its own line within the file: en_GB=British.

Ability to use languages without a locale

pi#2653

32809

Multilingual

Previously, translation files uploaded through the UI had to include both a language and locale as part of their ‘language code’ e.g. ‘messagesStatic_en_GB.properties' was accepted but the language only version of ‘messagesStatic_en.properties’ would have failed validation. If not using the 'languages.properties’ file detailed in the release note above, languages defined without the locale will appear in the Language Selectors without the parenthetical locale i.e. “English” rather than “English (United Kingdom)”

Add footer to Browser PDF export

#2535

-

PDF Export

A footer detailing the ‘generation date’ and ‘pages’ has been added to Browser PDF exports to maintain consistency with the previous Renderer export. The formatting of the date can be adjusted with the Global Variable PDF_DATE_FORMAT and the following CSS styles can be used to customise the three footer related classes defined in the Themes > PDF tab (.pi-style__pdf-footer, .pi-style__pdf-footer-date, .pi-style__pdf-footer-pages):

• background-color: The alpha channel of RGBA values will be ignored

• color

• text-align

• font-size: Only supports ‘px’ values or numeric values with no unit specified

• font-weight: Only “bold” has any effect

• font-style: Only “italic” has any effect

• margin: Only supports ‘px’ values or numeric values with no unit specified. Both specific margins (e.g. margin-right) and ‘margin’ value/array are supported

• display: Only supports ‘none’ to remove specific parts of the footer (.pi-style__pdf-footer-date, .pi-style__pdf-footer-pages) or the entirety of it if applied to `.pi-style__pdf-footer`

Example of footer with some of the styling mentioned above applied:

Image Removed

New Magic Variables - Date

pi#2651

31388 & 32934

Date Variables

The following magic variables relating to Date have been added to the system:

START_OF_NEXT_WEEK
END_OF_NEXT_WEEK
START_OF_NEXT_MONTH
END_OF_NEXT_MONTH
START_OF_LAST_YEAR
END_OF_LAST_YEAR
START_OF_NEXT_YEAR
END_OF_NEXT_YEAR
START_OF_QUARTER
END_OF_QUARTER
START_OF_LAST_QUARTER
END_OF_LAST_QUARTER
START_OF_NEXT_QUARTER
END_OF_NEXT_QUARTER
CURRENT_DAY_SHORT_NUMBER
CURRENT_DAY_WITH_SUFFIX
CURRENT_MONTH_SHORT_NUMBER
CURRENT_WEEKDAY_SHORT_NAME
LAST_MONTH_SHORT_NUMBER
NEXT_YEAR
NEXT_MONTH_YEAR
NEXT_MONTH
NEXT_MONTH_NAME
NEXT_MONTH_SHORT_NAME
NEXT_MONTH_SHORT_NUMBER

The full description of these environment variables can be found here: /wiki/spaces/DEV/pages/2151153665

Wildcard support for embed actions

pi#2865

-

Embedding

Embed actions (used to handle post message front-end actions when embedding) now supports a wildcard '*' in the trusted hosts setting and will allow a post message from any subdomain if the wildcard is provided.

CHANGES

Excluded Column Snackbar now times out

pi#2635

28990

Tables, Exports

Previously, you would have to close the snackbar that appears when exporting a table to Excel that has one or more columns marked as being excluded from export. Now, it will disappear on its own after a few seconds.

Enable chart editing when displayed in full screen

pi#2533

28243

Full screen chart viewer

Previously, you would be unable to edit a chart in full screen view. Now, you can freely edit the chart, and it will return you to full screen view once you have made your changes.

Image Removed

Correct positioning of custom map tooltips in full screen

pi#2610

32455

Full Screen Chart Viewer

When entering full-screen mode, the custom map will now be completely redrawn to adjust its dimensions, ensuring that tooltips are positioned correctly near the data labels.

Data labels and tooltip fixes for stacked bar charts in regards to totals and percentages

pi#2716

29704

Stacked Bar Charts

Previously, data labels and tooltips on stacked bar charts would omit negative values from the total value for each bar, which would also affect the percentages displayed for each bar segment. Now, the positive values minus the negative values is used for the total, and percentages for each segment are taken as a percentage of this new total.

Image Removed

A handful of additional fixes have been made off the back of a series of small bugs which were revealed due to this implementation.

1. We now ensure that ‘NaN%’ does not show when you click on legend items on regular and stacked bar charts

2. We now ensure that the percentage labels on bars within 100% stacked bar charts, regardless of whether the chart consists of 1 dimension and 1 measure, multiple dimensions, or multiple measure, are treated similarly to individual pie charts i.e. the percentage of a bar always adds up to 100%

3. We now ensure that negative values are suppressed from data labels and tooltips on 100% stacked bar charts - including regular and percentage data labels

4. We now ensure that any of the following charts that have negative values within the measures display a ‘suppressed negatives’ warning indicator on the top left of the chart: bar, stacked bar, 100% stacked bar, pie, doughnut, variable pie, variable doughnut, sunburst, doughnut sunburst, treemap, funnel & pyramid

5. We now ensure that, if only negative values appear on a bar within a regular bar chart or stacked bar chart, the percentage values are positive (i.e. the grand total is -30, and a segment is -15, this is 50% - NOT -50%)

New ‘configuration-tool' directory

configurationt-tool#134

29815

Configuration-tool

To ensure the app launches successfully across all Windows environments, we modified the build configuration to output the configuration-tool-GUI as an unpackaged directory containing all its files.

A new directory named configuration-tool has been created to house both the configuration-tool-GUI and configuration-tool command-line executables, along with all relevant files. The GUI will now launch directly from the configuration-tool directory.

Allow scheduler to use new browser export functionality

pi#2534, pi#2573 & pi#2574

Scheduler

The scheduler service will now utilise the new browser export functionality to generate charts that support it. This relates to PDF, Word and Powerpoint single chart exports.

Enhance log feedback for editable tables functionality

pi#2793

Editable Tables

Logging around the editable tables functionality has been improved, you will now always see the full outbound request detail for any failures and always if using debug level logging.

Default Dashboard Docker healthcheck changed to a single ping to health endpoint

pi#2655

Docker Healthcheck

Previously, the healthcheck script that runs on Docker would ping both ‘/version’ and ‘/pi’ to ascertain the health of the container. The latter ping was causing a repeated WARN log message to be produced and has now been removed. The ‘/version’ ping has been changed to include a --max-wait of 5s and hit the ‘/health’ endpoint instead.

Certain chart types not exporting as PDF

pi#2789

Charts

Fixed an issue that prevented certain chart types (gauge, flow, treemap) from being successfully exported to PDF format. The issue has been resolved, ensuring all chart types are now exported accurately, matching the visualisations in the UI.

Y axis zooming on merged charts bug

pi#2803

30898

Merged Charts

Previously, when you would try to zoom in on a merged chart with Y axis zooming enabled, then reset the zoom state, the tick intervals on the Y axis would be different from what they were when the chart was in its initial state. Now, the original tick intervals are retained once you have reset the zoom state.

Decimal places attribute not working on tables on 0 values

pi#2695

33190

Tables

Previously, when setting the decimal places of a measure within the chart attributes, on a table, which contains 0 values, the decimal places would not apply and the 0 values would fall back to using the decimal places defined in the object definition. Now, the decimal places defined in the chart attributes will always take precedence, and apply to 0 values successfully.

Prefix/Suffix no longer erroneously being applied to Crosstab headers derived from data rows

pi#2808

31550, 33844, 32481, 31550 & 22008

Crosstab Tables

Previously, measures in Crosstab tables (tables with a Header defined) would have their Data Object/Attribute formatting applied (e.g. a prefix) to not only their data values but also their respective headers. Now, this formatting only applies to the Header defined in the Chart Configuration as those headers are generated from the data values of that object.

Added missing 7-Zip files to Scheduler Docker Image fixing issues with Encrypted Schedules failing to send

pi#2810

32130

Encrypted Schedules, Docker

7-Zip is used to encrypt Schedules that you have added a password to but was missing from the Scheduler Docker image leading to the inability to use this feature. This has now been resolved and any previous workarounds you have applied to volume these files yourself can be deleted.

Switch all users to new Excel export functionality

pi#2697

33680

Exports

All users will now be moved across to the new version of the Excel export functionality, this version is significantly improved over the older version. As part of this work vulnerability CVE-2024-47554 in commons-io library has been removed from the dashboard.

‘Reset Zoom’ button no longer overlaps data in charts

pi#2805

33155

Chart Display

Previously, in certain scenarios, ‘Reset Zoom’ button was overlapping chart content when zooming in. This has been resolved by adding some additional space to the top of the chart container when zooming in, allowing the zoom button to appear outside the chart body. When zooming out, the space reverts to its original state.

Improved alignment of multi-line x-axis labels by making them centred to their respective data points

pi#2814

33153

Chart Display

Previously, certain chart sizes would result in multi-line x-axis labels that no longer properly matched the position of their data point. They would appear left-aligned with respect to the axis space reserved for that data point rather than central to it. This positional discrepancy looked particularly bad after zooming. The labels are now properly centrally aligned.

Before:

Image Removed

After:

Image Removed

Remove some Catalina WARNING logs on startup

pi#2816

29963

Logging, Tomcat

Previously, when starting up the Dashboard the catalina{date}.log file would show some warnings related to attempting to set ‘maximumSpareThreads’ and ‘proxyName’. These log messages should no longer appear.

Fix Tomcat > Advanced setting ‘Minimum Spare Threads’ not applying if set through the Configuration-Tool-Gui

configuration-tool#136

Configuration-Tool-GUI

Previously, changes to this configuration setting through the GUI would not be applied - this has now been resolved.

Errors appearing in console when zooming on a map with null values + maps with legends with null values not rendering at all

pi#2811

32903

Maps

Previously, maps with null values would display errors in the console when zooming in and out - this has now been resolved. Additionally, maps with legends with null values would not render at all - this has also been resolved.

Fix Subtotal Labels Not Being Translated

pi#2821

34224

Translations, Subtotals

Previously, subtotal labels were not being translated this has now been resolved

Fix Category List Panel blocking Category Object Value Selection popup in some scenarios

pi#2827

33571

Dashboard

When both the Category List Panel and Category Object Panel were pinned, it was possible for the Category Object Selection popup to be partially obscured by the Category List Panel - this has now been resolved.

Fix Modified Schedules With Role Links Failing To Import Due To Unique Constraint

migrations#62

Schedule Import

It was possible for a import that updates an existing Schedule that has Roles associated with it to fail with a message related to a unique constraint - this has been resolved

Fix Financial Year Start Calculation

pi#2649

34769

Date/Time Variables

Resolved an issue where the start of the financial year was incorrectly calculated when the currentMonth was earlier than the START_OF_FINANCIAL_YEAR_MONTH. The logic has been updated to ensure that in such cases, the start of the financial year is correctly determined as belonging to the previous calendar year. This change applies to both the financial environment variables and the values in the ‘Financial’ tab in the category objects date range panel.

Fixed issues with tomcat base directory when running Linux Dashboard through systemd

pi#2855

34380

Tomcat, Drivers

Due to changes in November related to how we initialise JDBC drivers in a more isolated way, the wrong tomcat base directory was being used for jdbc_drivers when using systemd. Similar issues were discovered due to this bug related to the dynamic drivers functionality and the location of the ‘out.{date}.log’ file (rotating Dashboard log file). These issues have now been resolved.

Fixed data connection export missing categories and charts

pi#2791

34273

Tomcat, Drivers

The API request for exporting a data connection will include the associated categories and charts.

Export to excel issue - exporting only three columns and three rows to a Rotated Table the export fails

pi#1541

28835

Info still needs to be added

“data” elements stay with the old language after changing the language in the GUI

pi#2828

29637

Info still needs to be added

Measure prefix showing ... too much

32481

Info still needs to be added

Bug - Cross Table Field Labels

33844

Info still needs to be added

New Config items always show [No Title] by default regardless of language

34016

Info still needs to be added

Bug - Unable to control height of Category Objects Panel when at the top AND using a multi-picker

34300

Info still needs to be added

When I have a child connection, I need to be able to prevent chart designer from building on the parent connection

34137

Info still needs to be added

I can get category objects in the wrong order

34411

Info still needs to be added

Bug - Upgrading versions and can't view categories

34768

Info still needs to be added

Linked data connection sub org user not picking VARIABLE from parent DC Organisation

35123

Info still needs to be added

Maps with legends do not display points if the measure is 0 or NULL

#2846

-

Info still needs to be added

Observability - Collect migration errors and log them at the end

#60

-

Info still needs to be added

MAINTAINANCE

Z-Zip Vulnerability

#93

-

Info still needs to be added

High Vulnerability - CVE-2024-56337

34784

Info still needs to be added

High Vulnerability - CVE-2024-50379

34785

Info still needs to be added

High vulnerability - CVE-2024-4735 - Denial of Service attack on windows app using netty

33940

Info still needs to be added

Medium vulnerability - cve-2023-44483 - santuario: Private Key disclosure in debug-log output

-

29289

Info still needs to be added

Minor Tomcat upgrade to resolve CVE-2024-56337 and CVE-2024-50379 (includes small additional configuration to fully resolve)

pi#2835, pi#2837, pi#2838

34785, 34753

Dashboard, Security

NEW FEATURES

Exporting To PDF - Added Footer For Browser PDF Exports	#2535	-	Exporting To PDF
A footer detailing the ‘generation date’ and ‘pages’ has been added to Browser PDF exports, to maintain consistency with the previous Renderer export. The formatting of the date can be adjusted with the Global Variable PDF_DATE_FORMAT, whilst the following CSS styles can be used to customise the three footer related classes defined in the Themes > PDF tab (.pi-style__pdf-footer, .pi-style__pdf-footer-date, .pi-style__pdf-footer-pages): background-color: The alpha channel of RGBA values will be ignored color text-align font-size: Only supports ‘px’ values or numeric values with no unit specified font-weight: Only “bold” has any effect font-style: Only “italic” has any effect margin: Only supports ‘px’ values or numeric values with no unit specified. Both specific margins (e.g. margin-right) and ‘margin’ value/array are supported display: Only supports ‘none’ to remove specific parts of the footer (.pi-style__pdf-footer-date, .pi-style__pdf-footer-pages) or the entirety of it if applied to `.pi-style__pdf-footer` Below is an example of the generated footer with some applied styling as mentioned above: Image Added

FEATURE CHANGES

Chart Editor - Ability To Edit In Full Screen Mode	pi#2533	28243	Chart Editor
Previously, you would be unable to edit a chart in full screen view. Now, you can freely edit the chart, and it will return you to full screen view once you have made your changes. Image Added

ToolTips & Data Labels - Stacked Bar Charts - Totals & Percentages Were Omitting Negative Values	pi#2716	29704	Tooltips & Data Labels
Previously, data labels and tooltips on stacked bar charts would omit negative values from the total value for each bar, which would also affect the percentages displayed for each bar segment. Now, the positive values minus the negative values is used for the total, and percentages for each segment are taken as a percentage of this new total. Image Added A handful of additional fixes have been made off the back of a series of smaller bugs revealed due to this implementation; Ensure that ‘NaN%’ does not show when you click on Legend items on Bar Charts and/or Stacked Bar Charts The percentage labels on the bars within 100% Stacked Bar Charts, are treated similarly to individual pie charts i.e. the percentage of a bar always adds up to 100% - regardless of if the chart consists of 1 dimension and 1 measure, multiple dimensions, or multiple measure, Negative values are suppressed from data labels and tooltips on 100% Stacked Bar Charts - including regular and percentage data labels Any of the following charts that have negative values within the measures display a ‘suppressed negatives’ warning indicator on the top left of the chart: Bar, Stacked Bar, 100% Stacked Bar, Pie, Doughnut, Variable Pie, Variable Doughnut, Sunburst, Doughnut Sunburst, Treemap, Funnel & Pyramid If only negative values appear on a bar within a regular Bar Chart or Stacked Bar Chart, the percentage values are positive (i.e. the grand total is -30, and a segment is -15, this is 50% - NOT -50%)

Data Labels - Improved Alignment Of Multi-Line X-Axis Labels - Centred Against The Data Point	pi#2814	33153	Data Labels / X Axis
Previously, certain chart sizes would result in multi-line x-axis labels that no longer properly matched the position of their data point. They would appear left-aligned with respect to the axis space reserved for that data point rather than central to it. This positional discrepancy looked particularly bad after zooming. The labels are now properly centrally aligned. Before: Image Added After: Image Added

Multilingual - New Config Items Labels Not Respecting Translated Language Until Save Performed	pi#2762	34016	Multilingual
During the process of creating a new Category, User, Role, Data Connection, Theme, API, Organisation, Report or Schedule, the new item would be described as 'No Title' (see the image below) until it was saved. The software now respects the language in use without the need to save it first. Image Added

This shows the structure of configuration in order for User to Edit Chart2

Org1 - Category1 - ParentOrgConn             <--- user subscribes to Org1 as a viewer without any permission
 ^               ^
 |               |
Org2 - Category2 - ChildOrgConn <-- Chart2   <--- [user is here in Org2]

1) Allow changing `Chart2` connection
Org1 - Cat1 -------------------- ParentOrgConn 
 |                      __(from)__/  |
 |                     /             |
Org2 - Cat2 --- Chart2 ---(to)--> ChildOrgConn         <--- [user is here]


2) Allow copying `Chart1` to `Chart2` and moving connection
Org1 - Cat1 --- Chart1 ---------- ParentOrgConn 
 |               |      __(from)__/  |
 |         (copy)|     /             |
Org2 - Cat2 --- Chart2 ---(to)--> ChildOrgConn         <--- [user is here]

MAINTENANCE

SCHEMA CHANGES