/
February 2025 - Dashboard Release Notes

February 2025 - Dashboard Release Notes

ย 

  • IMPORTANT NOTIFICATIONS

    • Scheme Changes - the release contains x1 schema changes - see HERE for more details


ย 

NEW FEATURES

ย 

Embedding - Open Report Editor - In Embedded Window

pi#2778

30721

Embedding / Report Editor

Embedding - Open Report Editor - In Embedded Window

pi#2778

30721

Embedding / Report Editor

New Release: pi-embed-actions library

We are excited to announce the release of our new JavaScript library, pi-embed-actions, designed to simplify interactions with the embedded pi dashboard. It provides an intuitive API to execute actions directly within the dashboard, minimising manual effort and making integrating pi into your application easier.

ย 

Open the Report Editor with Ease

To open the report editor within the embedded window, simply add the pi-embed-actions library to your code, use the API, and provide the required reportId. Here's an example of how to use it:

// Basic example of how to create a dashboard instance and embed a Report Editor: // 1. Create a dashboard instance, providing a valid iframeId and dashboardUrl. const dashboard = PiEmbedActions.createDashboard('iframeId', 'https://pi-dev.uk:8224/pi?lang=en_GB&editorDisplayMode=CONTENT'); // 2. Open a specific report in the editor, providing a valid report id. dashboard.reportEditor.open(2);

The library simplifies communication between the iframe and the dashboard by automatically sending instructions via post messages to open a specific report editor. This means you no longer have to manually manage this yourself in codeโ€”everything is taken care of seamlessly by the library!

You can also explore a full code example of embedding the report editor using the pi-embed-actions library here:- api-embed-example/static_examples/embed_report_editor.html at main ยท Panintelligence/api-embed-example

ย 

Future Updates

Weโ€™re committed to continuously improving the pi-embed-actions library. In the future, we plan to expand its API and capabilities to make embedding even easier and introduce exciting new features. Your feedback is invaluable in helping us make the library even better, so please feel free to share your experiences and suggestions with us!

ย 

Additional Resources

For more details about the library, check out the following links:

Docker Image - ARM Architecture Image Added For Dashboard

dashboard-deployment#97

24971

Docker Image / ARM Architecture

Docker Image - ARM Architecture Image Added For Dashboard

dashboard-deployment#97

24971

Docker Image / ARM Architecture

A separate ARM64 docker image has been added to the dashboard. Simply add the โ€œ_arm64โ€ suffix to the end of the image you are trying to access to get the correct image for this architecture, for example;

registry.panintelligence.cloud/panintelligence/dashboard/pi:latest_arm64. The original AMD branch will still exist for each release without this suffix.

ย 

N.B - the original AMD branch will still exist for each release without this suffix. This is currently only available for the dashboard project, but we will be adding more in the months to come.

Caching - Ability To Exclude A Chart From Data Connection Cache

pi#2819

34266

Caching

Caching - Ability To Exclude A Chart From Data Connection Cache

pi#2819

34266

Caching

Within the Chart Configuration screen, an option for โ€˜Exclude Chart From Cacheโ€™ has been available. This option relates to the browser caching of charts - and NOT the configurable Data Connection caching, which had caused some confusion. This option has been renamed from โ€˜Exclude Chart From Cacheโ€™ to become โ€˜Exclude Chart From Browser Cacheโ€™ to clarify its purpose.

To compliment this option, a new option called โ€˜Exclude Chart From Data Connection Cacheโ€™ has been added. The new option prevents a chart from being put into / retrieved from any Cache that has been configured for the relevant Data Connection.

ย 

N.B - the new setting does not configure the short-term โ€˜browser cacheโ€™ behaviour, therefore please ensure both are selected if you wish to always retrieve the data from the database for the chart in question.

Organisations - Ability For Organisation Admins To โ€˜Save Default Layout For Each Categoryโ€™

pi#2862

32433

Default Category Layout

Organisations - Ability For Organisation Admins To โ€˜Save Default Layout For Each Categoryโ€™

pi#2862

32433

Default Category Layout

Previously, only the Super Admin could see/use the โ€˜Save Default Layout For Each Category' button, in the โ€˜More Optionsโ€™ menu. This functionality has now been extended to the Organisation Admins too.

Unlike with the Super Admin, this feature will not work on all categories, rather it works for categories that the user has access to in Organisation where they:

  • Have the ability to manage that Organisation (i.e. it is not a Parent or detached child of their Owner Organisation)

  • Are an Admin User Type

  • Have the privileges associated with modifying/saving layouts

Whilst the ability to modify and save default layouts are Designer privileges, we have opted to restrict this functionality to users with a lot of access, as particularly across Organisations this feature can be very powerful.

Exporting To CSV - Performance Enhancements For Tables

pi#2823

28672

CSV Exports

Exporting To CSV - Performance Enhancements For Tables

pi#2823

28672

CSV Exports

We have implemented a more efficient CSV export functionality for tables, editable tables and rotated tables. The processing is now done in a more efficient manner reducing memory overheads and the chance of out-of-memory errors. In time the newer mode will apply to all CSV exports. If you experience any issue with this functionality you can temporarily switch back with the beta flag 'NON_SEG_CSV_EXPORT'.

Multi Lingual - Translations On The Chart Debug And Reporting Screens

pi#2911, pi#2916 & pi#2917

38672

Multi Lingual

Multi Lingual - Translations On The Chart Debug And Reporting Screens

pi#2911, pi#2916 & pi#2917

38672

Multi Lingual

Chart Debug Screen

Added missing translations for the highlighted items below in the chart debug screen:

Screenshot from 2025-02-20 11-19-12 (1)-20250220-112043.png

The following key-value pairs have been added to messagesStatic.properties file to translate the content:

app.debug.track.time.breakdown=breakdown
app.debug.track.time.i18n.and.swap.chart.i18n.micros=Chart i18n (micro-s)
app.debug.track.time.i18n.and.swap.chart.replacement.micros=Chart replacement (micro-s)
app.debug.track.time.i18n.and.swap.chart.step.preparation=preparation
app.debug.track.time.i18n.and.swap.chart.step.chart=chart
app.debug.track.time.i18n.and.swap.chart.step.hierarchy=hierarchy
app.debug.track.time.i18n.and.swap.chart.step.hierarchy.columns=hierarchy-columns
app.debug.track.time.i18n.and.swap.chart.step.chart.columns=chart-columns
app.debug.track.time.i18n.and.swap.chart.step.chart.colours=chart-colours
app.debug.track.time.i18n.and.swap.chart.step.chart.parameters=chart-parameters
app.debug.track.time.i18n.and.swap.chart.step.table.columns=table-columns

Reporting

  • Added a missing translation for a โ€˜Cancelโ€™ button for โ€˜Insert Link' popup in the report editor. Key - text.editor.insert.link.cancel.button

  • Corrected the keys used for the translations for the โ€˜importโ€™ button tooltip for both reports and schedules. Keys - report.import.instructions and schedule.import.instructions

Custom Fields - Index Field In A SubQuery For Custom Field

#2788

33214

ย 

Custom Fields - Index Field In A SubQuery For Custom Field

#2788

33214

ย 

The ability to use an Index Column in a Sub Query, for Custom Fields has been added.

ย 


ย 

ย 

CHANGES & MAINTENANCE

Merged Charts - Legend Items On Merged Charts

pi#922

19187

Merged Charts / Legend

Merged Charts - Legend Items On Merged Charts

pi#922

19187

Merged Charts / Legend

When merging charts that included the same legend values, this could result in the legend items being duplicated rather than being merged together as should be the case. All duplicated legend items will now be merged on all configurations where 2 or 3 charts are being merged.

ย 

N.B - additional legend items can be generated on merged charts when they have different X axes, these have not been merged together as part of this change.

Configuration Tool - Failing To Prevent The Dashboard Using systemd (โ€˜--no-systemdโ€™ Flag)

cfgtool#137

ย 

Configuration Tool

Configuration Tool - Failing To Prevent The Dashboard Using systemd (โ€˜--no-systemdโ€™ Flag)

cfgtool#137

ย 

Configuration Tool

When passing the --no-systemd flag to the Configuration Tool, the Dashboard would create and run service files through systemd if the user was root, which should not have occurred.

Exporting To Excel - Data Translations Not Appearing In Export Of Tables

pi#2845

34727

Export To Excel

Exporting To Excel - Data Translations Not Appearing In Export Of Tables

pi#2845

34727

Export To Excel

When performing an Export to Excel, when the Chart Configuration option of โ€œExport As Excel Without Formatโ€ having been set, the Titles, Subtitles, Headers and Group Headers were all being successfully translated in the export, however the actual values for these column were not.

Multi Lingual - Translation Of Report Import Button - Tooltip Not Translated

pi#2917

-

Multi Lingual

Multi Lingual - Translation Of Report Import Button - Tooltip Not Translated

pi#2917

-

Multi Lingual

When using a language other than English, when using the Reports module and navigating to the Import Report button, it was found that the Tooltip shown when hovering over the button was not being translated.

image-20250303-164514.png

Multi Lingual - Translation On Report - Insert Image Dialogue

pi#2916

-

Multi Lingual

Multi Lingual - Translation On Report - Insert Image Dialogue

pi#2916

-

Multi Lingual

When using a language other than English, when using the Reports module and navigating to the Report Editor screen, it was found that should you click on the Insert Image icon a dialogue boix would appear - however the Cancel option was not being translated to the chosen language.

image-20250303-164921.png

ย 

Observability - Software Version Details Being Logged At Startup

pi#2875

ย 

Observability / Software Version

Observability - Software Version Details Being Logged At Startup

pi#2875

ย 

Observability / Software Version

To further assist with issue investigations, the dashboard now logs the software version details into the standard log file as part of itโ€™s startup procedure.

Licence - Updated User Counting Logic, For Validation

pi#2877 & pi#2608

ย 34504, 30678, 34155, 34707 & 34878

Licence / User Count

Licence - Updated User Counting Logic, For Validation

pi#2877 & pi#2608

ย 34504, 30678, 34155, 34707 & 34878

Licence / User Count

The logic used to count licence users value has been updated to take into consideration Organisations users.

ย 

N.B - as part of this review, legacy code to count Lite Users has been removed.

Licence - Automated Licence Manager (ALM) Callback Being Incorrectly Related To โ€˜Grace Daysโ€™ Value

pi#2863

34050

Licence / ALM Callback

Licence - Automated Licence Manager (ALM) Callback Being Incorrectly Related To โ€˜Grace Daysโ€™ Value

pi#2863

34050

Licence / ALM Callback

Whilst related to licencing, โ€˜Grace daysโ€™ are not needed as a factor when monitoring the last time licences were checked against our ALM. Uses of โ€˜Grace daysโ€™ in this area have been replaced with hardcoded equivalents of the previous defaults.

A further issue with login being disabled prior to exceeding the callback window has also been addressed.

CSS - Improved Dashboard Display On Smaller Screens

pi#2778

34050

CSS / Styling

CSS - Improved Dashboard Display On Smaller Screens

pi#2778

34050

CSS / Styling

The dashboard styling has been to improved to aid the visibility of content primarily in the Dashboard Reporting and Dashboard Configuration screens.

The min-width has been set to 1520px, to ensure content does not overlap by maintaining a fixed minimum width. As a result, a horizontal scrollbar is available when needed, enhancing navigation and user experience on smaller screens.

Copy Charts - Unable To Copy Charts To A Target Organisation Without A Linked Data Connection

pi#2903

ย -

Linked Data Connections

Copy Charts - Unable To Copy Charts To A Target Organisation Without A Linked Data Connection

pi#2903

ย -

Linked Data Connections

Users were unable to copy charts if the Organisation did not have a linked data connection. In this scenario, a parent data connection will be used to attribute the chart to from this version forward.

New Category Objects - Incorrect List Of Values Being Displayed

#2861

34665

New Category Objects

New Category Objects - Incorrect List Of Values Being Displayed

#2861

34665

New Category Objects

Addressed an issue with the New Category Objects, where incorrect filter values were being seen, when moving and selecting values between different category objects

Library - Python Upgrade

pirana#57

ย 33946 & 33948

Library Upgrade

Library - Python Upgrade

pirana#57

ย 33946 & 33948

Library Upgrade

The Pirana project has been upgraded to Python 3.11, and the container has been re-based to Debian to reduce the size of the container - to address the CVE-2024-6345 vulnerability.

Library - Go Upgrade

scheduler#95 & pirana#97

ย 35104 & 35105

Library Upgrade / Vulnerability

Library - Go Upgrade

scheduler#95 & pirana#97

ย 35104 & 35105

Library Upgrade / Vulnerability

The Configuration Tool, Scheduler, and Excel Reader projects have received minor upgrades to their โ€˜Goโ€™ versions (1.23.1 โ†’ 1.23.6), to resolve the CVE-2024-45336 and CVE-2024-45341 vulnerabilities.

ย 


ย 

SCHEMA CHANGES

Description

Columns / Items

GitLab

ZenDesk

Description

Columns / Items

GitLab

ZenDesk

Added

exclude_chart_from_data_connection_cache to mis_defined_charts

pi#2819

34266

ย 

ย 

ย 

ย 

ย 

ย