April 2024 - Dashboard Release Notes

 

  • Customer requested changes are indicated with this icon

  • The 2024_04 release contains x1 schema changes


NEW FEATURES

 

Editable Tables - New HTTP Method - Send All Modified Rows In A Single Requested (JSON Format)

pi#2297

29070

Editable Tables

Editable Tables - New HTTP Method - Send All Modified Rows In A Single Requested (JSON Format)

pi#2297

29070

Editable Tables

A new option has been added for the HTTP Method, to be used for sending requests from an Editable Table. This new method, named “POST (JSON)” as opposed to the pre-existing method that has been renamed “POST (Classic)” will send all modified rows in a single request formatted in the following JSON structure:

{ dashboardUser: usercode, dashboardToken: token, modifiedRows: [ {colValue: firstRowValue1, colValue2: firstRowValue2}, {colValue: secondRowValue1, colValue2: secondRowValue2} ] }

To accommodate this new option, the radio buttons for this setting have been changed to a drop down as shown below:

pi-2297_new-method-in-drop-down.png

The GET request has also been updated to send the values as Form URL Encoded, allowing more complex data to be sent via this method

 

 

Sub Totals - Attribute Added To Enable On/Off Display Of Dimension Subtotal Break Labels

pi#2350

30256

Table Display - Sub Totals

Sub Totals - Attribute Added To Enable On/Off Display Of Dimension Subtotal Break Labels

pi#2350

30256

Table Display - Sub Totals

A new checkbox has been added to control whether the labels are shown for dimension subtotal breaks. By default, the checkbox will be unticked, hiding the labels next to subtotal break values.

The checkbox is only be available to Table chart type.

sub1.png

 

Once the checkbox is ticked, the labels will appear to all subtotal values, e.g.

 

 

New Magic Variable - LAST_MONTH_YEAR

pi#2345

29021

Magic Variables

New Magic Variable - LAST_MONTH_YEAR

pi#2345

29021

Magic Variables

Added a new Magic Variable [[LAST_MONTH_YEAR]] that resolves to the year (formatted yyyy) the previous month was in i.e. if the current month is January 2024 it will yield 2023.

See more information on Magic Variables HERE

 

 

Migrations - Ability To Skip Migrations

configuration-tool#132

-

Migrations

Migrations - Ability To Skip Migrations

configuration-tool#132

-

Migrations

Adding the ability to skip migrations by providing the following flag, under the ‘advanced’ section under ‘repository’ in the configuration tool:

It can also be applied by setting the following environment variable under the dashboard service in docker: PI_DB_SKIP_MIGRATIONS=”true”

This is an advanced setup option and to upgrade successfully, migrations MUST have run at least once. This is most useful when you use multiple Dashboard server nodes because you can more closely control the migration behaviour.

 

 

Multilingual - Translation For Category Object Types

pi#2296

29496

Multilingual

Multilingual - Translation For Category Object Types

pi#2296

29496

Multilingual

The following new entries have been added to the messagesStatic.properties file, to allow the translations of Category Objects types in the dropdown list.

List of new key=value pairs:

category.object.type.droplist.label=Drop List category.object.type.search.label=Multi-picker category.object.type.checkbox.label=Checkboxes category.object.type.images.label=Images category.object.type.slider.label=Slider category.object.type.num.picker.label=Number Picker category.object.type.single.date.picker.label=Single Date Picker category.object.type.date.picker.label=Date Range category.object.type.free.text.label=Free Text

If you wish to use these new fields, you will need to update the existing language files (e.g. messagesStatic_en_GB.properties, messagesStatic_pt_PT.properties) with the above keys and add your translated values.

 

Example of the result in the UI:

 

 

 

Multilingual - Translation For Confirmation Pop Up - When Closing A Tab With Unsaved Changes

pi#2294

29494

Configuration Screen

Multilingual - Translation For Confirmation Pop Up - When Closing A Tab With Unsaved Changes

pi#2294

29494

Configuration Screen

New associations and entries have been added between the Dashboard UI and the messagesStatic.properties file, to allow the translations of both the text and the hover text of elements on the pop up window - which appears when you attempt to close a tab with unsaved changes. Additionally, the yellow ‘unsaved changes’ indicator’s hover text is now translatable.

List of new key=value pairs:

default.button.edited.indicator.title=Modified and not saved default.button.save.title=Save changes default.button.cancel.title=Cancel to close this dialog default.button.discard.title=Discard changes and close the tab default.status.bar.message=You have made some changes, do you want to:

Pre-existing Key=Value pairs used:

If you wish to use these new fields, you will need to update the existing language files (e.g. messagesStatic_en_GB.properties, messagesStatic_pt_PT.properties) with the above keys and add your translated values.

 

Example of the result in the UI:

 

 

Data Connections - Additional Variable Replacement Options

#2326

28872

Data Connections

Data Connections - Additional Variable Replacement Options

#2326

28872

Data Connections

The JDBC URL field of Free Format Data Connections has been updated to allow the use of secure variables - it already supports insecure ones.

This also means that other data connections that have multiple fields that ultimately combine to form the JDBC URL, for example the ‘Host’ field, now support secure variables as well. Additionally, the Driver Class Path field that previously did not allow any variable replacement has been updated to support both secure and non-secure variable replacement.

The Username and Password fields still only allow for secure variable replacement however, they now have a lock icon with a tooltip to indicate that this is the case

 

 

 

Data Object Screen - Cursor Focus Improvement

pi#2301

-

Data Connection

Data Object Screen - Cursor Focus Improvement

pi#2301

-

Data Connection

Previously, after having written in one of the text boxes within the data objects screen, followed by selecting another text box to write to, you would have to click twice to focus on the 2nd text box. Now, you can click once and it will focus immediately as normal.

 

CHANGES

 

Duplicating Category Layout, When Duplicating A Category

pi#2302

29446

Categories

Duplicating Category Layout, When Duplicating A Category

pi#2302

29446

Categories

Previously, upon duplicating a category, it would not copy the category layout. This means all of the charts would need to be added manually. Now, it will attempt to copy the layout, following this hierarchy:

  1. If a default layout exists, it will copy that

  2. If a user layout exists for the user attempting to duplicate the category, and no default layout exists, it will copy that

  3. If no layout exists, it will copy nothing

 

 

User Management - Forename & Surname Option For The More Options Menu

pi#2328

28658

User Management

User Management - Forename & Surname Option For The More Options Menu

pi#2328

28658

User Management

A user’s Forename and Surname will now be used by default in the dropdown ‘More Options’ menu, and has been added to the User’s account screen.

When forename and/or surname are not provided, the option will default to using usercode.

More Options dropdown:

 

User Account screen:

 

 

 

Scheduler - Failing When A Disabled Users Or User Without An Email Address Are Present

scheduler#73

28374

Scheduler

Scheduler - Failing When A Disabled Users Or User Without An Email Address Are Present

scheduler#73

28374

Scheduler

Previously, upon detecting a disabled user or a user with a missing email, a schedule job would fail entirely. Now, it will simply skip over these users and continue scheduling to all other non-problematic users without fault. It will also skip over users under a role which are either disabled or have a missing email too.

 

 

piAnalytics - Decision Tree - MIN_SAMPLE_LEAF Added To DecisionTree

pirana#45

-

piAnalytics

piAnalytics - Decision Tree - MIN_SAMPLE_LEAF Added To DecisionTree

pirana#45

-

piAnalytics

We now include min_samples_leaf option to the decision tree logic in piAnalytics. This option imposes a constraint on the minimum number of samples required to be at a leaf node that prevents the tree from growing overly complex and capturing noise.

With this setting we can control the level of detail in the decision tree as larger leaf sizes result in simpler trees, which are easier to interpret. Each leaf node will contain at least 5% of the total samples. This setting for min_samples_leaf will be made configurable in an upcoming release.

 

 

Card Charts - Remove White Space Underneath A Card Chart (Desktop & Mobile Views)

pi#2252

29726, 29484, 29570, 29447 & 29313

Card Charts

Card Charts - Remove White Space Underneath A Card Chart (Desktop & Mobile Views)

pi#2252

29726, 29484, 29570, 29447 & 29313

Card Charts

Resolved various display and scaling issues of Card Charts, for desktop and mobile view.

Changed the way the size of the Card Chart container is being calculated; now use the width-height ratio that is applied to cards in the chart editor. As a result, when having multiple card charts in the same category, more content will be displayed in mobile view.

 

Here is an example video; (Safari, iOS 17.2, iPhone 15):

 

Improvements have also been made around the scaling of card charts, specifically when displaying large amounts of content.

 

 

Excel Export - Chart Title Inconsistencies

pi#2332

29629 & 29283

Excel Export

Excel Export - Chart Title Inconsistencies

pi#2332

29629 & 29283

Excel Export

Addressed an issue where incorrect chart title was used in Excel exports. Excel exports will now mirror the chart title displayed for the chart in the UI, that is consistent with the rest of export types e.g. if the chart title is defined in the ‘Attributes' section, this chart title will be used in the exported file.

 

 

Combined Charts - Not Drawing When Trend Line Is On

pi#2315

28859

Chart Display

Combined Charts - Not Drawing When Trend Line Is On

pi#2315

28859

Chart Display

Fixed an issue where the combined chart with multiple measures was breaking, if the trend line was being used and the data for all measures was put on the second y axis.

 

 

Exporting (PowerPoint & Excel) - NULL Values Should Display As Empty When Used In Dimensions

pi#2303 & pi#2306

29370

Exporting

Exporting (PowerPoint & Excel) - NULL Values Should Display As Empty When Used In Dimensions

pi#2303 & pi#2306

29370

Exporting

PowerPoint & Excel exports were showing a hardcoded 'NULL' value when NULL values were used in the dimension data. Instead, we now convert any NULL values into empty strings to reflect thew view in the UI. Currently, NULL values in the dimensions are shown as empty cells in the table in the dashboard.

 

 

Importing/Exporting - Removed Leading And Trailing Spaces From Identifiers

pi#2238

29354

Import / Export

Importing/Exporting - Removed Leading And Trailing Spaces From Identifiers

pi#2238

29354

Import / Export

Removed the leading and trailing spaces from the domain values, that are used as identifiers in export import functionality e.g. chart name, data connection name, category name, report name, schedule name. All leading and trailing spaces will now be trimmed before being saved to the database.

 

 

Go Library Upgrade - Upgrade PGX Package

scheduler#84

-

Scheduler

Go Library Upgrade - Upgrade PGX Package

scheduler#84

-

Scheduler

A high level SQL injection vulnerability (CVE-2024-27289) was reported in one of the GO libraries used by the scheduler. Although we don’t believe it would be possible to exploit, we’ve upgraded the library to fully mitigate against this.

 

 

Multilingual - Changes In i18n Language Files Now Picked Up Instantly (When Load Balanced)

pi#2376

30606 & 30643

Multilingual

Multilingual - Changes In i18n Language Files Now Picked Up Instantly (When Load Balanced)

pi#2376

30606 & 30643

Multilingual

Any changes to language files for i18n functionality, are now picked up immediately rather than requiring a cache clear which was the case previously. Language files need to be registered in the system to have changes picked, up so any brand-new files will require the application to be restarted before they are registered, as was the case previously.

 

SCHEMA CHANGES

 

SHOW_DIMENSION_BREAK_SUB_TOTAL_LABELS

 

 

Schema

SHOW_DIMENSION_BREAK_SUB_TOTAL_LABELS

 

 

Schema

Column added to mis_hierarchies table