Page Comparison

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 Removed

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.

Image Removed

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

Exporting 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 Three Columns & Three Rows On A Rotated Table Made Exports Fail

pi#1541

28835 & 24828

Exporting To Excel

When a Rotatable Table included three columns and three rows of data, when attempting to export this to excel, this would lead to the export failing.

Exporting To PDF - Certain Chart Types Unable 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 - Improved 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 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 Removed

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

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 Removed

After:

Image Removed

Configuration Tool - New Configuration Tool Directory

configurationt-tool#134

29815

Configuration Tool

To ensure the app launches successfully across all Windows environments, we have 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 - Minimum Spare Threads Changes Not Being Upheld Through The GUI

configuration-tool#136

-

Configuration Tool

Previously, changes made to the Advanced Setting ‘Minimum Spare Threads’ through the configuration tool were not being upheld.

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 were supported. This relates to PDF, Word and PowerPoint single chart exports.

Scheduler - Encrypted Schedules Failing To Send (Docker)

pi#2810

32130

Scheduler

7-Zip is used to encrypt Schedules that included a password, but was missing from the Scheduler Docker image - which led to the inability to use this feature. Whilst manual workaround were available for this, these are no longer needed.

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

migrations#62

-

Scheduler

It was possible for an import that updates an existing Schedule, that has Roles associated, to fail with a message related to a unique constraint.

Zooming - Y Axis Zooming - On Merged Charts

pi#2803

30898

Zooming / Merged Charts

Previously, when you tried to zoom in on a Merged Chart, with the Y axis zoom feature enabled and 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. The original tick intervals are now retained once you have reset the zoom state.

Zooming - Reset Zoom Button Overlapping Data In Charts

pi#2805

33155

Zooming / Chart Display

In certain scenarios, the ‘Reset Zoom’ button would overlap chart content when zooming in. Additional space has been added 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 (Zero) Values

pi#2695

33190

Tables

When setting the decimal places of a measure for a table which contains a 0 value (within the chart attributes), the decimal places would not apply and the 0 values would fall back to using the decimal places defined in the object definition. The decimal places defined in the chart attributes will now take precedence, and apply to 0 values correctly.

Tables - CrossTab Headings - Prefix/Suffix Incorrectly Being Applied To Measure Headings

pi#2808 & pi#1369

31550, 33844, 32481, 31550 & 22008

Tables

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. This formatting only applies to the Header defined in the Chart Configuration as those headers are now generated from the data values of that object.

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

pi#2655

-

Observability / Docker

The healthcheck script that runs on Docker would ping both ‘/version’ and ‘/pi’ to ascertain the health of the container. The '/pi' ping was causing a repeated WARN log message to be produced, which has 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 & Log Them At The End

#60

-

Observability / Logging

When performing migration processing, should SQL failures be encountered, these are now added to the end of logs to aid the triage process.

Logging - Remove Catalina WARNING Logs On Startup

pi#2816

29963

Logging / Tomcat

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

Logging - Enhanced Logging Feedback On Editable Table Feature

pi#2793

Logging / Editable Tables

Logging around the Editable Tables feature have been improved to assist with debugging of issue, with the full outbound request details along with success and failure details now being captured.

Logging - Errors Appearing In Console When Zooming On A Map With Null Values

pi#2811 & pi#2846

32903

Logging / Maps

Maps with null values would display errors in the console when zooming in and out. Furthermore, maps with legends with null values would not render at all, which has also been addressed.

Multilingual - Subtotal Labels Not Being Translated

pi#2821

34224

Multilingual

Subtotal labels were previously not being translated.

Multilingual - Data Elements Staying With The Old Language After Changing The Language In The GUI

pi#2828

29637

Multilingual

When selecting a new language in the GUI, not all translations were being performed, specifically around where [[VARIABLES]] were being used in queries. When the language is now changed through the GUI, the category/page will be refreshed to ensure all aspects of the charts are translated using the newly selected language.

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 Removed

Category Objects - The Model Popup Category Object Was Unable To Be Resized

pi#2827

33571 & 34300

Category Objects

When both the Category List Panel and Category Object Panel were pinned, it was possible for the Category Object Selection popup (model) to be partially obscured by the Category List panel.

Category Objects - Drop Down Data Out Of Sync

pi#2807

34411

Category Objects

Drop down data in Category Object filters could become out of sync if a user removes a preceding temporary category object filter value.

Magic Variables - Financial Year - Start Calculation

pi#2649

34769

Magic Variables

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 - Issues With Tomcat Base Directory When Running Linux Dashboard Through Systemd

pi#2855

34380

Linux / Tomcat

Due to changes introduced in the November 24, related to how we initialise JDBC drivers in a more isolated way, an incorrect Tomcat base directory was being used for jdbc_drivers when using systemd. Similar issues were discovered due to this issue, related to the dynamic drivers functionality and the location of the ‘out.{date}.log’ file (rotating Dashboard log file). Both issues have been addressed.

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

pi#2786

34137

Data Connections - Linked

Info still needs to be added

Data Connections - Linked - Sub Org User Not Picking VARIABLE From Parent Date Connection Organisation

pi#2888

35123

Data Connections - Linked

Info still needs to be added

MAINTAINANCE

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]

MAINTENANCE

SCHEMA CHANGES