Skip to end of banner
Go to start of banner

January 2025 - Dashboard Release Notes

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 10 Next »

  • IMPORTANT NOTIFICATIONS

    • Scheme Changes - this 2025_01 release contains x3 schema changes - see HERE for more details

    • Feature Deprecation - the old version of the Excel Export functionality is no longer available to revert to, which previously has been set using the OLD_EXCELBETA flag. By default, only the New Excel Export feature is now available from this version onwards. See HERE for more information.


NEW FEATURES

Multilingual - Ability To Define The Languages Available & Named Display 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.

Multilingual - 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)”

Magic Variables - New Date/Period Based Variables Added

pi#2651

31388 & 32934

Magic 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

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-20241206-155407.png

Embedding - Wildcard Support Added For Embed Actions - Trusted Hosts Settings

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.

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.

Screenshot from 2024-11-25 10-49-51.png

Exporting A To Excel - Switch all users to new Excel export functionality

pi#2697

33680

Exporting To Excel

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.

Exporting A To Excel - Tables - Excluded Column Snackbar Now Times Out

pi#2635

28990

Exporting To Excel

Previously, you would have to close the snackbar that appears when exporting a table to Excel, when one or more columns was marked as being excluded from export. It now disappears automatically after a few seconds.

Exporting To Excel - Exporting only three columns and three rows to a Rotated Table the export fails

pi#1541

28835

Exporting To Excel

Info still needs to be added

Exporting To PDF - Certain Chart Types Not Able To Export

pi#2789

Exporting To PDF

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.

Tooltips - Correct Positioning Of Custom Map Tooltips (Full Screen Mode)

pi#2610

32455

ToolTips

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.

ToolTips & Data Labels - Stacked Bar Charts - Totals & Percentages 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.

Screenshot from 2024-11-26 14-11-26.png

A handful of additional fixes have been made off the back of a series of smaller bugs revealed due to this implementation;

  1. Ensure that ‘NaN%’ does not show when you click on Legend items on Bar Charts and/or Stacked Bar Charts

  2. 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,

  3. Negative values are suppressed from data labels and tooltips on 100% Stacked Bar Charts - including regular and percentage data labels

  4. 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:

    1. Bar, Stacked Bar, 100% Stacked Bar, Pie, Doughnut, Variable Pie, Variable Doughnut, Sunburst, Doughnut Sunburst, Treemap, Funnel & Pyramid

  5. 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%)

Configuration Tool - 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.

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

configuration-tool#136

Configuration Tool

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

Scheduler - Allow The Scheduler To Use New Browser Export Functionality (Single Chart Exports)

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.

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

pi#2810

32130

Scheduler / 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.

Scheduler - Modified Schedules With Role Links Failing To Import Due To Unique Constraint

migrations#62

Scheduler / Importing

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

Zooming - Y Axis Zooming - On Merged Charts

pi#2803

30898

Zooming / 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.

Zooming - Reset Zoom’ button no longer overlaps data in charts

pi#2805

33155

Zooming / 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.

Tables - 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.

Tables - CrossTab Headings - Prefix/Suffix no longer erroneously being applied to Crosstab headers derived from data rows

pi#2808

31550, 33844, 32481, 31550 & 22008

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.

Tables - Cross Table Field Labels

33844

Tables

Info still needs to be added

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

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:

2814-before.png

After:

2814-after.png

Observability - Docker Healthcheck - Default Dashboard Healthcheck Changed To A Single Ping

pi#2655

Observability / Docker

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.

Observability - Collect migration errors and log them at the end

#60

-

Observability / Logging

Info still needs to be added

Logging - 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.

Logging - Enhanced Logging Feedback On Editable Table Feature

pi#2793

Logging / 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.

Logging - 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

Logging / 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.

Multilingual - Fix Subtotal Labels Not Being Translated

pi#2821

34224

Multilingual

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

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

pi#2828

29637

Multilingual

Info still needs to be added

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

34016

Multilingual

Info still needs to be added

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

pi#2827

33571

Category Objects

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.

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

34300

Category Objects

Info still needs to be added

Category Objects - I can get category objects in the wrong order

34411

Category Objects

Info still needs to be added

Magic Variables - Financial Year Start Calculation

pi#2649

34769

Magic 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.

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

pi#2855

34380

Linux / Tomcat

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.

Data Connections - Exporting - Missing Categories & Charts

pi#2791

34273

Data Connections - Exporting

The API request for exporting a data connection now includes the associated Categories & Charts.

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

34137

Data Connections - Linked

Info still needs to be added

Data Connections - Linked - Sub org user not picking VARIABLE from parent DC Organisation

35123

Data Connections - Linked

Info still needs to be added

Measures - prefix showing ... too much

32481

Measures

Info still needs to be added

Upgrading - versions and can't view categories

34768

Upgrading

Info still needs to be added

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

#2846

-

Maps

Info still needs to be added

MAINTAINANCE

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

33940

Info still needs to be added

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

-

29289

Info still needs to be added

Vulnerability - CVE-2024-56337 and CVE-2024-50379

pi#2835, pi#2837, pi#2838

34785, 34753 & 34784

Vulnerability / Tomcat

Tomcat upgraded from 9.0.97 to 9.0.98 and the useCanonCaches Tomcat property explicitly set to false.

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

Vulnerability - CVE-2024-29025

pi#2389

30738

Vulnerability / Library Upgrades

Updated the Lettuce library from version 6.1.10 to 6.5.1.

Vulnerability - CVE-2024-45337

scheduler#94

34466

Vulnerability / Library Upgrades

Updated the Crypto and Net packages to the most recent versions. This addressed vulnerabilities around the Scheduler and Excel Reader modules.

Vulnerability - Code TBC

scheduler#93

28990

Vulnerability / Library Upgrades

Updated the 7 zip library from version 23.01 to 24.09. This library is used for encryption within the Scheduler.

Vulnerability - CVE-2024-43382

pi#2720

33846

Vulnerability / JDBC Driver

Updated the Snowflake JDBC driver from version 3.14.1 to 3.20.0 (latest).


SCHEMA CHANGES

 

Description

GitLab

ZenDesk

Index added on mis_audits.audit_date_time and mis_audits.user_code

migrations#62

31663

Foreign Key added between pi_schedule_user_links.schedule_id and pi_schedules.id

migrations#62

31663

Unique constraint added on pi_schedule_user_link between user_id and schedule_id

migrations#62

31663

 

  • No labels

0 Comments

You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account.